PHP_CodeSniffer规则文档 [已关闭]

php coding-style pear

2022-08-30 19:13:57

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

答案 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`

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

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

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类的路径，我们就能够知道PHP_CodeSniffer将要报告的嗅探。例如，在 CodeSniffer/Standards/Squiz/Sniffs/NameingConventions/ValidFunctionNameSniff 中实现的类.php将生成标识符为的嗅探。Squiz.NamingConventions.ValidFunctionName

答案 2

试试这个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规则文档 [已关闭]

1. 选项-s

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

3. 最终，源代码

1. 选项`-s`

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