Question

哪里可以找到有关PHP_CodeSniffer规则的文档？在我看来，规则存在，但没有人知道它们的列表及其属性。我遇到了基本的问题，我想自定义一个标准，并在语句除以一个空格后在同一行上强制大括号开始，并且看不到任何方法。这只是一个问题，但我还有很多其他问题。谢谢。

Answer 1

查看源代码可能很可怕，但最后，如果要列出所有可能的规则（或嗅探，PHP_CodeSniffer调用它们），你必须查看源代码。

我遇到了同样的问题，我使用了三种技术：

1。选项`-s`

phpcs命令有一个选项，用于输出未遵循嗅探的标识符。让我们看一个例子：

$ 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

在报告中，每个错误或警告都会输出嗅探。

2。源代码中的`ruleset.xml`个文件

项目中必须遵循或忽略哪些规则的配置通常在ruleset.xml文件中定义。 PHP_CodeSniffer源代码有一些示例。 PHP_CodeSniffer定义了几个标准：Generic，PSR1，PSR2，......每个标准都有一个ruleset.xml文件。您可以向他们学习如何创建自己的。

此技术要求您查看源代码，但您只需要读取类似于项目中可能具有的文件。例如，您可以在CodeSniffer/Standards/PSR2文件夹下找到PSR2标准的ruleset.xml文件。

3。最终，源代码

最后，如果你想要全面的嗅探列表，你需要从源代码中提取它们。让我们解码如何构建嗅探标识符。

很容易知道实现嗅探的PHP类。例如，让我们Generic.Commenting.Todo.TaskFound。三个第一个令牌意味着：

Generic：它是标准，它定义了标准文件夹CodeSniffer/Standards/Generic
Commenting：它是标准下的嗅探组，它还指向标准内的文件夹：CodeSniffer/Standards/Generic/Sniffs/Commenting
Todo：它是嗅觉，它是在名为<sniff name>Sniff.php

所以，我们已经在CodeSniffer/Standards/Generic/Sniffs/Commenting/TodoSniff.php类中实现了Generic.Commenting.Todo.TaskFound嗅探。

我们可以做相反的事情。如果我们知道PHP类的路径，我们就能知道将要报告的sniff PHP_CodeSniffer。例如，CodeSniffer/Standards/Squiz/Sniffs/NamingConventions/ValidFunctionNameSniff.php中实现的类将生成标识为Squiz.NamingConventions.ValidFunctionName的嗅探。

Answer 2

除了source code之外，没有关于规则的文档。看看不同的标准以及他们如何使用它们。

Answer 3

旧问题，但我觉得这很有用： http://pear.php.net/package/PHP_CodeSniffer/docs/latest/

它列出了Pear包中的所有文件以及以＃34; Sniff＆＃34;结尾的所有文件。是可用的支票。

Answer 4

试试这个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>

PHP_CodeSniffer规则文档

4 个答案:

1。选项`-s`

2。源代码中的`ruleset.xml`个文件

3。最终，源代码

PHP_CodeSniffer规则文档

4 个答案:

1。选项-s

2。源代码中的ruleset.xml个文件

3。最终，源代码

1。选项`-s`

2。源代码中的`ruleset.xml`个文件