README

🚀 Introduction

phpstan-rules is an extensible package of custom rules for PHPStan that helps you maintain high code quality and consistency in your PHP projects.

📦 Installation

composer require --dev pekral/phpstan-rules

⚙️ Usage

Add phpstan.neon or extend your existing configuration file with this package.
Run PHPStan with this extension:

vendor/bin/phpstan analyse src/

📝 Example configuration (phpstan.neon)

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

parameters:
    level: max
    paths:
        - src

🔒 Strict and Deprecation Rules

This package is designed to work seamlessly with phpstan/phpstan-strict-rules and phpstan/phpstan-deprecation-rules. These packages provide extra strict and deprecation-related rules for PHPStan, helping you enforce best practices and avoid deprecated code usage.

To enable these rules, make sure you have both packages installed (they are included in the dependencies) and add them to your phpstan.neon configuration:

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

You can then configure strict rules in the parameters > strictRules section of your phpstan.neon file. For a full list of available strict rules, see the phpstan-strict-rules documentation.

❓ FAQ

Q: How do I add a custom rule? A: Create your own rule class and add it to the PHPStan configuration.

Q: How do I run PHPStan only on specific folders? A: Adjust the path in the PHPStan command, e.g. src/, app/.

Q: How can I contribute? A: Open an issue or pull request on GitHub.

🔗 Further resources

📝 License

This package is licensed under the MIT license.

About

A package for extending PHPStan with custom rules. Suitable for teams and individuals who want to maintain high PHP code quality.

pekral / phpstan-rules

Maintainers

Details