PHP_CodeSniffer自定义代码规范规则

安装完PHP_CodeSniffer（v 2.7.0）,默认的规则检测以及提示文案都在

/path/to/php/lib/php/PHP/CodeSniffer/Standards/

该目录有已安装的规范包，例如：MySource, PEAR, Squiz, PSR1, Zend, PHPCS, PSR2等。

下面给出几个修改自定义规则：

1、去除命名空间规范规则

当前规范为PSR2，进入到相关目录

/path/to/php/lib/php/PHP/CodeSniffer/Standards/PSR2

查看 ruleset.xml 文件会发现PSR2规范引用了PSR1的规则

经过一番检查发现，namespace的规则判断位于以下目录

/path/to/php/lib/php/PHP/CodeSniffer/Standards/PSR1/Sniffs/Classes

查看文件  ClassDeclarationSniff.php 注释以下代码即可去除命名空间规范规则

2、新增变量书写规范

在PSR2的 ruleset.xml 规则文件中，加入新规则

<!-->add new start<--><!-->新增的限制变量规范<--><rule ref="PEAR.NamingConventions.ValidVariableName"/><!-->add new end<-->

新规则为PEAR中变量限制规则嗅探，默认嗅探为类的成员变量的处理，现在我们需要自定义普通变量的规则

vim /path/to/php/lib/php/PHP/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidVariableNameSniff.php

在当前文件的 processVariable() 方法中加入以下代码

$tokens = $phpcsFile->getTokens();
$member_name = ltrim($tokens[$stackPtr]['content'], '$');
//新增限制变量名非驼峰
if ($member_name != strtolower($member_name) || substr($member_name,0,1) == '_' || substr($member_name,-1) == '_') {
       $error = 'Variable name format is no camelCaps';
       $data  = array($member_name);
       $phpcsFile->addError($error, $stackPtr, 'VariableNameNocamelCaps', $data);
       return;
}

获取$符号的变量，并且判断变量名称是否为大小写开头的驼峰命名，若名称为驼峰，则抛出错误。

以上几条为修改PHP_CodeSniffer自定义规则实例，欢迎补充。

原文地址：http://www.aabiji.com/notes/notes/id/18.html