颜色 / 代码野兽
Composer 包,用于生成 Git 钩以自动化代码质量控制
dev-master
2019-07-31 14:14 UTC
Requires
- php: >=7.0
- dealerdirect/phpcodesniffer-composer-installer: *
- drupal/coder: ^8.2.12
- phpmd/phpmd: @stable
- squizlabs/php_codesniffer: 3.*
- symfony/console: >=2.7
Requires (Dev)
Suggests
- your git hooks: run 'vendor/bin/codebeast configure' to set up your hook configuration
This package is auto-updated.
Last update: 2024-09-29 05:09:23 UTC
README
用途
此包用于在开发过程和 Git 工作流程中自动化代码质量控制。它安装依赖项,例如:phpcs、phpcbf、phpmd,并根据用户偏好配置 pre-commit Git 钩。在创建提交之前执行 pre-commit Git 钩,因此提交中添加的代码会与语法错误、违反代码标准以及违反某些结构标准(phpmd)进行核对。
使用方法
要配置 Git 钩并生成设置文件,请使用以下命令
vendor/bin/codebeast configure
配置命令生成 pre-commit.settings 文件,可以将其添加到仓库中,以便每个团队成员在项目中都有相同的设置。配置命令还建议安装钩子。
要安装钩子,请按照 '配置' 命令的向导操作或运行以下命令
vendor/bin/codebeast install
安装命令设置到您的 vendor 文件夹的路径(绝对路径),并在目标 .git 目录中创建 pre-commit 钩子文件。
配置
此包附带 minimal.xml 文件中的 phpmd 配置。您可以根据 文档 创建自己的 phpmd 配置文件。其余的配置在执行 '配置' 命令的向导过程中完成。