Ale*_*der 18 php pear coding-style
哪里可以找到有关PHP_CodeSniffer规则的文档？在我看来,规则存在,但没有人知道它们的列表及其属性.我遇到了基本的问题,我想自定义一个标准,并在语句除以一个空格后在同一行上强制大括号开始,并且看不到任何方法.这只是一个问题,但我还有很多其他问题.谢谢.
rch*_*ria 11
查看源代码可以是可怕的,但最终,如果要列出所有可能的规则(或嗅探作为PHP_CodeSniffer称他们),你必须看看源代码.
我有同样的问题,我使用了三种技术:
-sphpcscommand有一个选项,输出未遵循嗅探的标识符.我们来看一个例子:
$ phpcs -p -s --extensions=php /path/to/my/source/code
...E...E....W.....W..E.............W........................ 60 / 723 (8%)
.......................W.................................... 120 / 723 (17%)
.............................W..W....E..................E..E 180 / 723 (25%)
----------------------------------------------------------------------
60 | ERROR | [x] Line indented incorrectly; expected at least 2 spaces,
| | found 0 (Generic.WhiteSpace.ScopeIndent.Incorrect)
----------------------------------------------------------------------
61 | WARNING | Comment refers to a TODO task "Improve readability"
| | (Generic.Commenting.Todo.TaskFound)
----------------------------------------------------------------------
... output has been truncated
Time: 2 mins, 9.46 secs; Memory: 25.5Mb
在报告中,每个错误或警告都会输出嗅探.
ruleset.xml源代码中的文件必须在项目中遵循或忽略规则的配置通常在ruleset.xml文件中定义.PHP_CodeSniffer源代码有一些示例.PHP_CodeSniffer定义了几个标准:Generic,PSR1,PSR2,......每个标准都有一个ruleset.xml文件.您可以向他们学习如何创建自己的.
这种技术要求您查看源代码,但您只需要读取类似于项目中可能具有的文件.例如,您可以ruleset.xml在该CodeSniffer/Standards/PSR2文件夹下找到PSR2标准的文件.
最后,如果您需要全面的嗅探列表,则需要从源代码中提取它们.让我们解码如何构建嗅探标识符.
很容易知道实现嗅探的PHP类.例如,我们来看看Generic.Commenting.Todo.TaskFound.三个第一个令牌意味着:
Generic:它是标准,它定义了标准的文件夹 CodeSniffer/Standards/GenericCommenting:它是标准下的嗅探组,它还指向标准内的文件夹: CodeSniffer/Standards/Generic/Sniffs/CommentingTodo:它是嗅探器,它是在一个叫做的类中实现的 <sniff name>Sniff.php所以,我们Generic.Commenting.Todo.TaskFound在CodeSniffer/Standards/Generic/Sniffs/Commenting/TodoSniff.php课堂上实现了嗅探.
我们可以做相反的事情.如果我们知道PHP类的路径,我们就能知道将要报告的sniff PHP_CodeSniffer.例如,实现的类CodeSniffer/Standards/Squiz/Sniffs/NamingConventions/ValidFunctionNameSniff.php将生成带有标识符的嗅探Squiz.NamingConventions.ValidFunctionName.
试试这个 PHP 脚本。
将$standardsDirectory更改为正确的路径。
<?php
/**
* PHP_CodeSniffer "Standards" directory!
*/
$standardsDirectory = __DIR__. '/Standards';
/**
* Scan directory (recursive)
*/
function _scandir($path)
{
$list = [];
$elms = scandir($path);
if(!$elms)
return false;
foreach($elms as $elm)
{
if($elm == '.' || $elm == '..')
continue;
$fullpath = $path .'/'. $elm;
if(is_file($fullpath))
{
$list[] = $fullpath;
}
elseif(is_dir($fullpath))
{
$sublist = _scandir($fullpath);
$list = array_merge($list, $sublist);
}
}
return $list;
}
$list = [];
$files = _scandir($standardsDirectory);
foreach($files as $file)
{
if(preg_match('@Standards/(.*?)/Sniffs/(.*?)/(.*?)Sniff.php@i', $file, $matches))
{
$key = $matches[2] .'.'. $matches[3];
$desc = null;
$data = file_get_contents($file);
if($data)
{
$data = explode("\n", $data);
$desc = trim($data[2], " \t*");
}
$list[ $key ] = [
'shortName' => $matches[2] .'.'. $matches[3],
'fullName' => $matches[1] .'.'. $matches[2] .'.'. $matches[3],
'path' => $matches[0],
'desc' => $desc,
];
}
}
ksort($list);
?>
<html>
<body style="font-family: Consolas, 'Lucida Console';">
<table>
<?php foreach($list as $e): ?>
<tr align="left">
<th><?=$e['shortName']?></th>
<td><?=$e['fullName']?></td>
<td><?=$e['desc']?></td>
</tr>
<?php endforeach; ?>
</table>
</body>
</html>