greencape / joomla-cs
1.0.1
2015-11-14 02:57 UTC
This package is auto-updated.
Last update: 2019-09-01 16:47:36 UTC
README
此存储库包含用于与 Composer 一起使用的 PHP CodeSniffer 2.x 的编码标准定义。
目前,以下编码标准已被包含
- Joomla! 编码标准
- WordPress 编码标准
- PHP CodeSniffer 本地提供的编码标准包括 PEAR、PSR1、PSR2、Squiz 和 Zend 编码标准。
要求
- PHP 5.3+
- Composer
安装
将此包添加到您的需求中。
$ composer require --dev greencape/coding-standards:~1
PHP CodeSniffer 工具将自动安装到匹配的版本。
您可以使用以下命令验证安装是否成功:
$ ./vendor/bin/phpcs -i The installed coding standards are MySource, PSR2, Squiz, Zend, PHPCS, PSR1, PEAR, WordPress and Joomla
运行
您可以使用已安装的 Joomla 标准如下
$ ./vendor/bin/phpcs --standard=Joomla path/to/code $ ./vendor/bin/phpcbf --standard=Joomla path/to/code
您可以使用已安装的 WordPress 标准如下
$ ./vendor/bin/phpcs --standard=WordPress path/to/code $ ./vendor/bin/phpcbf --standard=WordPress path/to/code
在两种情况下,第二行(phpcbf
)将自动修复一些问题。然而,这部分仍在进行中,并将随着时间的推移而改进。
贡献
如果您想为此项目做出贡献,您可以
- 在这个存储库上进行分支,编写代码,并发送 Pull Request
- 在 问题跟踪器 中提交问题