creatuity/magento-quality-tools

此包的最新版本（v1.0.1）没有提供许可信息。

基于GrumPHP工具的Composer包，为Magento项目预定义了配置

维护者

详情

github.com/creatuity/magento-quality-tools

来源

问题

安装次数: 4,511

依赖: 0

建议: 0

安全: 0

星标: 1

关注者: 3

分支: 0

开放问题: 3

v1.0.1 2022-08-26 11:21 UTC

Requires

Unknown License f529ea52187bbc7a0bb13a74e86242690a4f5742

This package is not auto-updated.

Last update: 2024-09-17 13:44:57 UTC

README

安装

composer require --dev creatuity/magento-quality-tools

当系统提示时，请勿在根目录下创建grumphp.yml文件

将以下内容添加到您的composer.json

  "extra": {
    "grumphp": {
            "config-default-path": "vendor/creatuity/magento-quality-tools/src/grumphp.yml"
        }
  }

根据与Magento编码标准包的问题，还需要将其添加到您的composer.json文件中

 "scripts": {
        "post-install-cmd": [
            "([ $COMPOSER_DEV_MODE -eq 0 ] || vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/,../../phpcompatibility/php-compatibility)"
        ]
    },

并运行composer install以应用更改。

使用方法

  • 请确保您的更改已处于GIT暂存区。
  • 当您想要提交更改时，请输入。
./vendor/bin/grumphp git:pre-commit

仅对提交的代码运行grumphp.yml中定义的任务。当您尝试提交时，也会运行此命令 - 它使用git pre-commit钩子。

内置任务

此包包含grumphp.yml文件的预定义配置，因此您可以直接安装并使用它。目前，该包包含以下任务

  • jsonlint
  • xmllint
  • phplint
  • yamllint
  • composer
  • phpcs
  • phpcsfixer2
  • phpmd
  • phpstan - 当前级别设置为6
  • git_commit_message - 此任务验证提交消息。正文和主题的允许长度限制为120个字符。它还要求从任务编号开始消息，例如 - [PROJECTX-123] 测试提交
  • git_branch_name - 此任务验证分支名称。它允许使用两种类型的分支名称
    • 任务分支 - 以hotfix|bugfix|feature前缀开头，包含任务编号和简短描述，例如 - feature/PROJECTX-short-description
    • 发布分支 - release/0.1.1
  • git_blacklist - 此任务检查开发者是否未使用黑名单中的单词，如var_dump或console.log

兼容性

  • Magento >= 2.4.2
  • PHP版本 >= 7.2 || >= 8.1

已知问题

  • 如果您收到类似以下错误
Warning: class_implements(): Class Vendor\Module\Setup\Patch\Data\ExamplePatch does not exist and could not be loaded in /dev/tests/static/framework/Magento/CodeMessDetector/Rule/Design/AllPurposeAction.php on line 35

请检查GitHub上的此问题 magento/magento2#33430