ssch/typo3-phpstan-rules

Set of PHPStan rules for TYPO3 projects

dev-main / 1.0.x-dev 2023-09-04 20:22 UTC

Requires

• php: ^8.0
• phpstan/phpstan: ^1.7
• symplify/phpstan-rules: ^10.0 || ^11.0
• typo3/cms-core: ^8.7 || ^9.5 || ^10.4 || 11.5 || 12.*.*@dev
• typo3/cms-extbase: ^8.7 || ^9.5 || ^10.4 || 11.5 || 12.*.*@dev

Requires (Dev)

• phpstan/extension-installer: ^1.1
• phpstan/phpstan-strict-rules: ^1.0
• phpunit/phpunit: ^9.5
• rector/rector: ^0.13
• symplify/coding-standard: ^10.0
• symplify/easy-coding-standard: ^10.0
• symplify/phpstan-extensions: ^10.0
• symplify/rule-doc-generator: ^10.0

MIT

• Sebastian Schreiber

README

TYPO3 PHPStan Rules

Set of (opinionated) rules for PHPStan in TYPO3 Projects

• See Rules Overview

Install

composer require ssch/typo3-phpstan-rules --dev

If you also install phpstan/extension-installer then you're all set for the version independent rules.

Manual installation

If you don't want to use phpstan/extension-installer, include general_typo3_rules.neon in your project's PHPStan config:

includes:
    - vendor/ssch/typo3-phpstan-rules/config/general_typo3_rules.neon

In order to load the TYPO3 version dependent rules, include them manually in your PHPStan config:

includes:
    - vendor/ssch/typo3-phpstan-rules/config/v11/rules.neon
    - vendor/ssch/typo3-phpstan-rules/config/v10/rules.neon
    - vendor/ssch/typo3-phpstan-rules/config/v9/rules.neon
    - vendor/ssch/typo3-phpstan-rules/config/v8/rules.neon

They are not building on each other, so include only the one for your targeted version.