README

Coke 是一个使用 PHP Code Sniffer 的 Shell/Bash 命令，允许按项目进行规则管理。

配置文件

在项目根目录创建一个 .coke 文件

# Command used to launch PHP CodeSniffer (optional - default: phpcs)
command=phpcs
 
# Path used to load Standards (optional)
standard-path=path/to/PHPCS/Standards/

# Standard used by PHP CodeSniffer (required)
standard=Symfony2
 
# Verbose mode (optional - default: false)
verbose=true
 
# Only Git changed mode (optional - default: false)
only-git-changed=true
 
# White list of files and directories (optional)
src/
test.php
 
# Black list of files and directories (optional)
!Tests
!src/OldFile.php

然后只需运行命令

$ coke

带有参数运行命令

您可以通过将配置直接作为参数传递给命令来覆盖 .coke 设置

$ coke src test.php --standard=Symfony2 --ignore=Tests,src/OldFile.php -v

参数的顺序不重要

src test.php 要检查的文件/目录
--standard=Symfony2 用于检查的标准
--ignore=Tests,src/OldFile.php 要忽略的 URL 模式
--only-git-changed 只检查已更改的文件
-v 使用详细模式

附加参数

您可以使用任何 phpcs 参数（文档）

例如，如果您想使用您最喜欢的 CI 工具生成报告，可以运行

$ coke --report-checkstyle=checkstyle.xml

通过 Composer 安装

在您的 composer.json 的 require-dev 部分添加 coke

"require-dev": {
    "m6web/coke" : "~2.0"
}

默认情况下，Composer 将在 vendor/bin/coke 中添加 coke 的符号链接。

如果您想更改它，请将此添加到您的 composer.json 中（有关更多信息，请参阅 Composer 文档）

"config": {
    "bin-dir": "bin"
}

然后您可以通过以下方式调用 coke

./bin/coke

Git pre-commit 钩子

您可以使用一个专门的 pre-commit 钩子

$ wget --output-document=.git/hooks/pre-commit https://gist.githubusercontent.com/JJK801/5867810/raw/f26ec4778273b3f7140428252ab31951de2faba4/pre-commit.sh

或者

$ curl -L https://gist.githubusercontent.com/JJK801/5867810/raw/f26ec4778273b3f7140428252ab31951de2faba4/pre-commit.sh > .git/hooks/pre-commit

然后

$ chmod +x .git/hooks/pre-commit

致谢

由 Cytron Team 的 M6 Web 开发。

许可证

Coke 在 MIT 许可证 下授权。