dereuromark / codesniffer-standards
此软件包已被弃用,不再维护。未建议替代包。
用于与 phpcs-fixer 一起使用的自定义 CodeSniffer 标准,是 phpcs 的自动修复分支。
dev-master
2014-09-20 16:26 UTC
Requires
- cakephp/cakephp-codesniffer: dev-phpcs-fixer
- squizlabs/php_codesniffer: 2.*
Requires (Dev)
This package is not auto-updated.
Last update: 2018-05-08 19:29:55 UTC
README
有用的 CodeSniffer 标准用于与 phpcs 一起使用。它们超越了原始存储库提供的功能,或包括重要的修复。
这些标准仅适用于 phpcs-fixer 分支。它们只能与代码检查工具的这个分支一起工作。
安装
{ "require-dev": { "dereuromark/codesniffer-standards": "dev-master" } }
如果您只想通过 --standard=/path/to/custom/ruleset.xml
链接嗅探器。
否则使用
php composer.phar require dereuromark/codesniffer-standards
phpcs --config-set installed_paths vendor/dereuromark/codesniffer-standards
第二个命令让 phpcs
知道如何找到您的新嗅探器。确保您不会覆盖任何现有的 installed_paths
值。
使用
根据您如何安装代码检查器,运行它的方式会有所不同。
如果您已安装 phpcs,您可以进行以下操作
phpcs --standard=MyStandard /path/to/code
等。
如果没有,您可以像上面那样链接到规则集 XML 文件。
标准
CakePHP
CakePHP 的官方编码标准,为 phpcs-fixer 版本。让修复器自动修正找到的问题。节省时间和精力。
MyCakePHP
一个自定义标准,具有许多附加的嗅探器和以下修复
- 文档块缩进正确(与类的方法和属性在同一级别)
- Windows 上的换行符允许是 \r\n
依赖关系
- CakePHP 标准
MyCakePHPCore
一个自定义标准,符合官方 CakePHP 编码标准,具有许多附加的嗅探器和以下修复
- Windows 上的换行符允许是 \r\n
依赖关系
- CakePHP 标准
- MyCakePHP 标准
贡献
如果您想为 CodeSniffer 标准做出贡献,您可以分叉项目,添加功能并提交拉取请求。