🌐 AI搜索 & 代理 主页
Skip to content

A collection of PHPStan rules to enforce best practices and standards in database migration files for Phinx and Laravel / Illuminate.

License

Notifications You must be signed in to change notification settings

Bellangelo/phpstan-migration-rules

Repository files navigation

PHPStan Rules for Database Migrations

A collection of PHPStan rules to enforce best practices and standards in database migration files for Phinx and Laravel / Illuminate.

Installation

composer require --dev bellangelo/phpstan-migration-rules

The extension will be automatically registered if you have phpstan/extension-installer installed. Otherwise, add it manually to your phpstan.neon:

includes:
    - vendor/bellangelo/phpstan-migration-rules/extension.neon

Rule catalog

Each rule below applies to migration files, regardless of framework, unless stated otherwise.

Rule: EnforceCollationRule

Enforces that table definitions explicitly define a collation.

Prevents relying on database defaults, which may differ between environments.

Configuration

parameters:
    phpstanMigrationRules:
        requiredCollation: utf8mb4 # Default is utf8

Support

Framework How collation is detected
Phinx table('name', ['collation' => '…'])
Laravel $table->collation('…') or $table->collation = '…' inside the Blueprint callback

Rule: ForbidAfterRule

Forbids column positioning via after.

May trigger full table rewrites or long locks, unsafe for large or production tables.

Support

Framework Forbidden usage
Phinx addColumn(..., ['after' => 'column'])
Laravel $table->string('x')->after('y')

Rule: ForbidMultipleTableCreationsRule

Ensures each migration creates at most one table.

Improves rollback safety and migration clarity


Support

Framework What counts as a table creation
Phinx Multiple calls to create() on table instances
Laravel Multiple Schema::create() calls in the same migration

About

A collection of PHPStan rules to enforce best practices and standards in database migration files for Phinx and Laravel / Illuminate.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages