leaphub/phpcs-symfony2-standard
v2.0.3
2015-03-25 10:07 UTC
Requires
README
一个可安装的编码标准,用于检查与Symfony编码标准的兼容性。
此项目基于@lapistano提供的标准。
安装
此编码标准可以通过composer安装,也可以在PHP_CodeSniffer安装中通过PECL使用。以下是两种方法的描述,但推荐使用composer方法。
使用Composer
-
将标准作为基于composer的项目依赖项安装(它将安装PHP_CodeSniffer的composer版本作为依赖项)
$ php composer.phar require --dev leaphub/phpcs-symfony2-standard:~2.0.0
-
完成!
$ bin/phpcs --standard=vendor/leaphub/phpcs-symfony2-standard/leaphub/phpcs/Symfony2/ --extensions=php src/
使用PEAR
-
安装PHP_CodeSniffer
$ pear install PHP_CodeSniffer
-
找到您的PEAR目录
$ pear config-show | grep php_dir
-
将此仓库复制、符号链接或检出到名为Symfony2的文件夹中,该文件夹位于phpcs
Standards
目录下$ cd /path/to/pear/PHP/CodeSniffer/Standards $ git clone git@github.com:leaphub/phpcs-symfony2-standard.git Symfony2
-
如果您想,可以将Symfony2设置为默认编码标准
$ phpcs --config-set default_standard Symfony2
-
完成!
$ phpcs --standard=Symfony2 --extensions=php src/
贡献
如果您为这些sniffs贡献代码,请确保它符合PEAR编码标准,并且Symfony2-coding-standard单元测试仍然通过。
要检查编码标准,请在Symfony2-coding-standard源根目录下运行
$ phpcs --ignore=*/tests/* --standard=PEAR . -n
单元测试是在PHP_CodeSniffer目录内运行的
$ phpunit --filter Symfony2_* tests/AllTests.php