lasselehtinen/laravel-conventions-checker

grumphp 配置，用于自动检查 Laravel 项目的约定

维护者

详细信息

github.com/lasselehtinen/laravel-conventions-checker

源代码

问题

安装数: 8,064

依赖项: 3

建议者: 0

安全性: 0

星标: 22

关注者: 5

分支: 2

开放问题: 0

v5.0.0 2023-12-19 09:19 UTC

Requires

MIT ac9f01b5c1147a49fc48ddab72262e0a1cbfbb0d

  • Lasse Lehtinen <lasse.lehtinen.woop@iki.fi>

This package is auto-updated.

Last update: 2024-09-19 11:00:06 UTC

README

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

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

安装

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

composer require --dev lasselehtinen/laravel-conventions-checker

2. 下载 Local PHP Security Checker

从Github 的发行页面下载二进制文件，将其重命名为 local-php-security-checker 并使其可执行。

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

    "extra": {
        "grumphp": {
            "config-default-path": "vendor/lasselehtinen/laravel-conventions-checker/grumphp.yml"
        }
    }

测试套件

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

vendor/bin/grumphp run --testsuite=syntax
vendor/bin/grumphp run --testsuite=style
vendor/bin/grumphp run --testsuite=static

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 获取更多信息。