elgentos/testing-suite

该软件包最新版本(0.2.1)没有可用的许可证信息。

Elgentos 测试套件

0.2.1 2023-06-15 13:26 UTC

This package is auto-updated.

Last update: 2024-09-15 16:14:37 UTC


README

本工具使用 youwe/testing-suite,但我们可以根据自己的喜好添加/更改测试、软件包或配置。

安装

composer require elgentos/testing-suite --dev

配置

将其添加到您的 phpstan.neon 文件中;

includes:
    - vendor/bitexpert/phpstan-magento/extension.neon

基线

在将此工具集成到现有项目时,您可能希望考虑生成基线,以便测试可以通过,而无需修复所有文件。

Phpstan 基线

生成基线(将 app/design/frontend app/code 替换为您自己的目录);

vendor/bin/phpstan analyse --level 4 --configuration ./phpstan.neon app/code app/design/frontend --generate-baseline

然后将其添加到您的 phpstan.neon 文件中;

includes:
  - phpstan-baseline.neon

Phpmd 基线

生成基线(将 app/design/frontend,app/code 替换为您自己的目录);

vendor/bin/phpmd app/design/frontend,app/code text ./phpmd.xml --generate-baseline

Phpcs 基线

生成基线(将 app/design/frontend app/code 替换为您自己的目录);

vendor/bin/phpcs app/design/frontend app/code --extensions=php,phtml --report=\\DR\\CodeSnifferBaseline\\Reports\\Baseline --report-file=phpcs.baseline.xml --basepath=.\

运行它

vendor/bin/grumphp run

Gitlab CI/CD

如果您正在将此工具集成到现有项目,请确保所有测试都通过(或添加基线)。一旦所有测试都通过,请确保在我们的内部 Gitlab CI/CD 中将静态测试作业设置为必需,通过将以下内容添加到项目的 .gitlab-ci.yml 文件中。

static:testingsuite:
  allow_failure: false

配置 Phpstorm

这假设您正在使用我们的Docker开发环境

  1. 转到 设置 > PHP > 质量工具
  2. PHP_CodeSnifferMess DetectorPHP CS FixerPHPStan 执行以下步骤
    1. 单击配置下拉列表后面的 ...
    2. 单击蓝色 + 符号
    3. 选择 development_php81:latest,点击确定
    4. 点击确定
  3. 转到 设置 > 编辑器 > 检查 > PHP > 质量工具
    1. 禁用 PHP CS Fixer 验证
    2. 启用 PHP Mess Detector 验证
      1. 在“自定义规则集”下,清除列表并添加 vendor/youwe/coding-standard-magento2/src/YouweMagento2/
      2. 单击应用
    3. 启用 PHP_CodeSniffer 验证
      1. 在“编码标准”下,选择“YouweMagento2”
      2. 单击应用
    4. 启用 PHPStan 验证
      1. 确保配置文件和自动加载文件路径为空
      2. 确保在项目根目录中有 phpstan.neon 文件
      3. 单击应用
    5. 禁用 Psalm 验证