diviky/code-analysis

grumphp 配置以自动检查 Laravel 项目的约定


README

grumphp的配置,每次提交都会检查提交的代码是否通过单元测试,符合 PSR2 编码风格和静态分析检查。它执行以下检查:

  • 检查 composer.json 是否有效
  • 使用SensioLabs 安全检查器检查 composer 是否存在已知安全漏洞的依赖项
  • 检查提交中不包含任何调试代码(var_dump、die、exit)
  • 检查代码是否符合 PSR2 编码风格
  • 使用phpstan执行静态代码分析
  • 使用PHP Mess Detector检查代码中的不必要复杂性等
  • 使用 PHPUnit 检查代码通过单元测试

安装

1. 将检查器添加到您的 composer.json

composer require --dev diviky/code-analysis

2. 将 grumphp 配置文件的路径添加到 composer.json 的 extra 中

    "extra": {
        "grumphp": {
            "config-default-path": "vendor/diviky/code-analysis/grumphp.yml"
        }
    }

测试套件

如果您只想运行编码风格或静态分析检查,可以运行以下命令

php artisan self-diagnosis

composer validate

vendor/bin/grumphp run --testsuite=style
vendor/bin/grumphp run --testsuite=static
vendor/bin/php-cs-fixer fix --allow-risky=yes
vendor/bin/psalm
vendor/bin/phpstan analyse src
vendor/bin/testbench package:test --parallel
vendor/bin/phpunit --coverage-html coverage

许可证

MIT 许可证(MIT)。有关更多信息,请参阅许可证文件