Create Phpstan Config

PHPStan Configuration Generator

Generates optimized PHPStan configurations for PHP 8.4+ projects.

All examples target PHPStan 2.x: level accepts 0-10 (10 = max), and parameters removed in 2.0 (checkMissingIterableValueType, checkGenericClassInNonGenericObjectType, checkExplicitMixed, checkImplicitMixed) must never be generated — they abort the run.

Generated Files

phpstan.neon              # Main configuration
phpstan-baseline.neon     # Error baseline (if needed)

Configuration by Project Type

New Project (Level 8-9)

# phpstan.neon
includes:
    - vendor/phpstan/phpstan-strict-rules/rules.neon
    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
    - vendor/phpstan/phpstan-phpunit/extension.neon

parameters:
    level: 8
    phpVersion: 80400

    paths:
        - src
        - tests

    excludePaths:
        - tests/Fixtures/*
        - src/Infrastructure/Legacy/*

    # Strict type checking (raise `level` for stricter checks: 9 = explicit mixed, 10 = implicit mixed)
    checkUninitializedProperties: true
    treatPhpDocTypesAsCertain: true
    reportUnmatchedIgnoredErrors: true

    # Parallel processing
    parallel:
        maximumNumberOfProcesses: 4

Existing Project with Baseline

# phpstan.neon
includes:
    - phpstan-baseline.neon
    - vendor/phpstan/phpstan-strict-rules/rules.neon
    - vendor/phpstan/phpstan-deprecation-rules/rules.neon

parameters:
    level: 6

    paths:
        - src
        - tests

    excludePaths:
        - src/Legacy/*
        - tests/Fixtures/*

    # Gradually increase strictness: bump `level` one step at a time (0-10)
    treatPhpDocTypesAsCertain: false
    reportUnmatchedIgnoredErrors: false

    # Type aliases for legacy code
    typeAliases:
        UserId: 'int|string'
        Timestamp: 'int|DateTimeInterface'

DDD Project Configuration

# phpstan.neon
includes:
    - vendor/phpstan/phpstan-strict-rules/rules.neon
    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
    - vendor/phpstan/phpstan-phpunit/extension.neon
    - vendor/phpstan/phpstan-doctrine/extension.neon

parameters:
    level: 9
    phpVersion: 80400

    paths:
        - src

    excludePaths:
        - src/Infrastructure/Migrations/*

    # Strict for Domain layer (level 9 already forbids explicit mixed; use level 10 for implicit mixed)
    checkUninitializedProperties: true
    treatPhpDocTypesAsCertain: true

    # Report all issues
    reportUnmatchedIgnoredErrors: true
    reportStaticMethodSignatures: true

    # Parallel for speed
    parallel:
        maximumNumberOfProcesses: 8
        processTimeout: 300.0

    # Custom parameters
    doctrine:
        repositoryClass: App\Infrastructure\Persistence\DoctrineRepository
        objectManagerLoader: tests/object-manager.php

    # Ignore patterns (entry is either a delimited regex string, or a map with `message`/`identifier`)
    ignoreErrors:
        # Doctrine entities
        -
            message: '#Property .+ has no type specified#'
            path: src/Infrastructure/Doctrine/Entity/*

        # Value Objects immutability
        -
            message: '#Readonly property .+ is assigned outside of its declaring class#'
            path: src/Domain/*/ValueObject/*

    # Custom rules
    rules:
        - App\PHPStan\DomainLayerRule
        - App\PHPStan\ValueObjectImmutabilityRule

Extension Configuration

PHPUnit Extension

includes:
    - vendor/phpstan/phpstan-phpunit/extension.neon

parameters:
    # PHPUnit-specific settings
    phpunit:
        configPath: phpunit.xml

Doctrine Extension

includes:
    - vendor/phpstan/phpstan-doctrine/extension.neon

parameters:
    doctrine:
        repositoryClass: Doctrine\ORM\EntityRepository
        objectManagerLoader: tests/object-manager.php

Symfony Extension

includes:
    - vendor/phpstan/phpstan-symfony/extension.neon
    - vendor/phpstan/phpstan-symfony/rules.neon

parameters:
    symfony:
        containerXmlPath: var/cache/dev/App_KernelDevDebugContainer.xml
        consoleApplicationLoader: tests/console-application.php

Custom Error Patterns

Common Ignore Patterns

parameters:
    ignoreErrors:
        # Constructor property promotion
        - '#Constructor of class .+ has an unused parameter#'

        # Doctrine entities
        -
            message: '#Property .+ does not accept null#'
            path: src/Infrastructure/Doctrine/Entity/*

        # Test doubles
        -
            message: '#Call to an undefined method .+Mock::#'
            path: tests/*

        # Dynamic properties in tests
        -
            message: '#Access to an undefined property .+Test::\$#'
            path: tests/*

        # Factory methods
        - '#Method .+Factory::create\(\) should return .+ but returns#'

        # Event handlers
        - '#Parameter .+ of method .+Handler::__invoke\(\) has no type specified#'

Error Baseline Generation

# Generate baseline for existing errors
vendor/bin/phpstan analyse --generate-baseline

# Generate baseline with specific name
vendor/bin/phpstan analyse --generate-baseline=phpstan-baseline.neon

# Analyze and exclude baseline errors
vendor/bin/phpstan analyse

Level Migration Guide

From Level 0 to Level 8

# Step 1: Start with baseline at current level
parameters:
    level: 0

# Step 2: Generate baseline
# vendor/bin/phpstan analyse --generate-baseline

# Step 3: Increase level
parameters:
    level: 1

# Step 4: Fix new errors or add to baseline
# Repeat until level 8

Recommended Progression

CI Configuration

GitHub Actions

phpstan:
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@v4
    - uses: shivammathur/setup-php@v2
      with:
        php-version: '8.4'
    - run: composer install
    - run: vendor/bin/phpstan analyse --memory-limit=1G --error-format=github

GitLab CI

phpstan:
  script:
    - vendor/bin/phpstan analyse --memory-limit=1G --error-format=gitlab > phpstan.json
  artifacts:
    reports:
      codequality: phpstan.json

Performance Optimization

parameters:
    # Parallel processing
    parallel:
        maximumNumberOfProcesses: 8
        processTimeout: 300.0

    # Cache results
    tmpDir: var/cache/phpstan

    # Memory limit
    memoryLimitFile: 1G

Generation Instructions

1. Analyze project:

   • Check composer.json for PHPStan version
   • Check existing phpstan.neon
   • Identify framework (Symfony, Laravel, etc.)
   • Count existing errors

2. Determine level:

   • New project: Level 8-9
   • Existing with few errors: Current + 1
   • Legacy: Level 0 + baseline

3. Add extensions:

   • PHPUnit if tests exist
   • Doctrine if ORM used
   • Symfony/Laravel if framework

4. Generate baseline if needed:

   • For existing projects with errors
   • Include command to regenerate

Usage

Provide:

• Project type (new/existing/legacy)
• Framework (Symfony, Laravel, none)
• Current error count (if existing)
• Target level (optional)

The generator will:

1. Create appropriate configuration
2. Add relevant extensions
3. Include ignore patterns
4. Generate baseline commands if needed