cierrateam / cierra-qa
cierra 质量保证（qa）工具
Requires
- php: ^7.3|^8.0
- nunomaduro/larastan: ^0.6.12
- slevomat/coding-standard: ^6.4.1
- squizlabs/php_codesniffer: ^3.5.8
Requires (Dev)
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-24 18:16:49 UTC
README
cierra QA（质量保证）是一个简单的包，它将代码质量工具集成到您的项目中。
将要集成到您的项目的QA工具
此外，它将在 .github/workflows 下为您的项目创建一个GitHub工作流程文件，以在拉取请求上运行QA工具。
安装
首先，您可以使用Composer将Cierra QA安装到您的项目中
composer require --dev cierrateam/cierra-qa
要复制QA文件到您的项目中，您必须运行以下命令
php artisan cierra-qa:install
此命令将在您的根项目中创建一个名为 .qa 的文件夹，其中包含 PHP_CodeSniffer 和 Larastan 的配置文件。
它还将在 .github/workflows 目录中创建一个 code-quality.yml 文件，并在项目根目录中创建一个 Makefile 文件。
❗️ 确保保存现有的 Makefile，如果有的话。
配置
您可以在 .qa 目录中更新您的项目的配置/规则文件，以便符合您的标准。
❗️ 请将 code-quality.yml 中的 php-version 更新为您的项目使用的版本，以便QA工具在拉取请求上使用正确的PHP版本。
默认情况下，QA工具使用 /app 目录进行分析。您可以在 Makefile 中的 PHP_FILES 下更改默认路径。
默认的 phpstan 级别为5。您也可以在 Makefile 中的 PHPSTAN_LEVEL 下更新它。
使用
在方便的时候安装和配置QA工具后，您可以使用 Makefile 快捷方式快速使用 PHP_CodeSniffer 和 Larastan。
- 使用
make phpcs运行PHP_CodeSniffer分析/app文件夹。 - 使用
make phpstan运行Larastan分析/app文件夹。
❗️ 您可以在 Makefile 中的 PHP_FILES 和 PHPSTAN_LEVEL 下更改要分析的路徑和 phpstan 级别，或者直接使用 make 命令提供路径：make phpstan LEVEL=3 FILES="foo/bar/baz.php foo/bar/foo.php"
如果您不想分析 app 下的整个项目文件，您也可以仅检查已更改的文件。
运行 git add .，然后运行 make phpcs-quick 或 make phpstan-quick。
PHPSTORM
在 .dev/ide/phpstorm/settings 下存储了一个代码风格文件，可以导入到您的PHPStorm ide中的 Preferences --> Editor --> Code Style。