缓存CodeSniffer（以及PHPMD）

Question

在Mars发布之前，可以在Eclipse中安装PHPMD支持，尽管有some caveats and difficulties。

现在PTI的支持似乎已被完全删除，即使development of PHPMD hasn't stopped和PHPMD确实提供了其他工具不支持的某些功能：例如，detect unused variables。

^{对于这最后一个功能，我发现了not too recent CodeSniffer plugin可以解决问题。还有some sniffs应该做的工作，但它们似乎不适合我，或者至少在所有情况下都不起作用：我有一个需要重构的项目，我有11个来自CodeSniffer的警告来自PHPMD的2524。}

我认为我有一种简单而不优雅的方法可以重新加入PHPMD，但在做之前，我想知道是否有人有这个特定的相同问题/需要，以及他/她是否设法解决不知何故。

Answer 1

好的，就这样。

我有一个可以从命令行运行的PHPMD二进制文件。我打算做的是将其输出注入CodeSniffer插件的输出，以及＃34;以丰富＆＃34;后者使用PHPMD消息。

为此，我对phpcs.php目录中的plugins/org.ppsrc.eclipse.pti.tools.codesniffer_.../php/tools进行了修改。

（因为我对CodeSniffer的另一个问题是它经常会重新扫描应该知道的文件，所以我决定给CodeSniffer一个内存。

首先，我提取调用的最后一个参数，即正在分析的文件（标有+++的行是我的添加/更改）：

// Optionally use PHP_Timer to print time/memory stats for the run.
// Note that the reports are the ones who actually print the data
// as they decide if it is ok to print this data to screen.
@include_once 'PHP/Timer.php';
if (class_exists('PHP_Timer', false) === true) {
    PHP_Timer::start();
}

if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) {
    include_once dirname(__FILE__).'/../CodeSniffer/CLI.php';
} else {
    include_once 'PHP/CodeSniffer/CLI.php';
}

+++ $lastArgument   = array_pop($_SERVER['argv']);

然后我添加一些CS似乎没有通过的标志，我需要，例如忽略一些目录：

+++ $_SERVER['argv'][]  = '--ignore=tests,vendor,cache';
+++ $_SERVER['argv'][]  = $lastArgument;

然后CS调用继续进行，但现在我将其结果保存到缓冲区而不是直接发送到Eclipse。

$phpcs = new PHP_CodeSniffer_CLI();
$phpcs->checkRequirements();
+++ ob_start();
$numErrors = $phpcs->process();

+++ $dom    = new DOMDocument();
+++ $dom->loadXML(ob_get_clean());

+++ $cs     = $dom->getElementsByTagName('phpcs')->item(0);
+++ $xpath  = new DOMXPath($dom);

现在我将PHPCS输出准备为XML。

剩下的就是使用自己的语法调用PHPMD。

// Add PHPMD.
$mdCmd  = "C:/PHP/composer/vendor/phpmd/phpmd/src/bin/phpmd \"{$lastArgument}\" xml \"C:/Program Files/eclipse/plugins/org.phpsrc.eclipse.pti.library.pear_1.2.2.R20120127000000/php/library/PEAR/data/PHP_PMD/resources/rulesets/codesize.xml,C:/Program Files/eclipse/plugins/org.phpsrc.eclipse.pti.library.pear_1.2.2.R20120127000000/php/library/PEAR/data/PHP_PMD/resources/rulesets/naming.xml,C:/Program Files/eclipse/plugins/org.phpsrc.eclipse.pti.library.pear_1.2.2.R20120127000000/php/library/PEAR/data/PHP_PMD/resources/rulesets/unusedcode.xml\"";

...并将其加载到另一个XML中：

    fprintf(STDERR, $mdCmd . "\n");
    $dompmd = new DOMDocument();
    $dompmd->loadXML($mdxml = shell_exec($mdCmd));

现在我从PMD对象中获取所有错误，并将其添加到CS中：

    $files  = $dompmd->getElementsByTagName('file');
    foreach ($files as $file) {
        $name   = $file->getAttribute('name');
        $list   = $xpath->query("//file[@name=\"{$name}\"]");
        if (null === $list) {
            continue;
        }
        $csFile = $list->item(0);
        if (null === $csFile) {
            // No errors from CS.
            $csFile = $dom->createElement('file');
            $csFile->setAttribute('name', $name);
            $csFile->setAttribute('errors', 0);
            $csFile->setAttribute('warnings', 0);
            $csFile->setAttribute('fixable', 0);
            $cs->appendChild($csFile);
        }
        $errs   = 0;
        foreach ($file->childNodes as $violation) {
            if ($violation instanceof \DOMText) {
                continue;
            }
            $error  = $dom->createElement('warning', trim($violation->nodeValue));


            $error->setAttribute('line', $violation->getAttribute('beginline'));
            $error->setAttribute('column', 1);
            $error->setAttribute('source', 'PHPMD.' . $violation->getAttribute('ruleset'));
            $error->setAttribute('severity', $violation->getAttribute('priority'));
            $error->setAttribute('fixable', 0);

            $csFile->appendChild($error);

            $errs++;
        }
        $csFile->getAttributeNode('errors')->value += $errs;
    }

最后，将数据发送回Eclipse：

print $dom->saveXML();
exit($numErrors ? 1: 0);

缓存CodeSniffer（以及PHPMD）

由于CodeSniffer的另一个问题是它经常会重新扫描应该知道的文件，所以我决定给CodeSniffer一个内存。这很简单：我可以存储一个临时文件，其中包含已保存的XML以及由原始文件名的MD5构建的名称和其内容：

/tmp/68ce1959ef67bcc94e05084e2e20462a.76e55e72f32156a20a183de82fe0b3b6.xml

因此，当要求PHPCS分析/path/to/file/so-and-so.php时，它将：

创建文件名的MD5。
创建其内容的MD5。
如果/tmp/md5file.md5content.xml不存在：
- 删除任何/tmp/md5file.*.xml有：它们已经过时了。
- 按上述方式运行代码。
- 将结果保存到/tmp/md5file.md5content.xml
输出/tmp/md5file.md5content.xml。

PHPMD（PHP Mess Detector）集成在Eclipse Mars中

1 个答案:

缓存CodeSniffer（以及PHPMD）