mirror of
https://we.phorge.it/source/arcanist.git
synced 2025-02-13 15:28:34 +01:00
2c5c9815c0
Summary:
Ref T3186. Ref T2039. Ref T3771. A few effects here:
# Expose PHPCS as a `.arclint` linter.
# Turn PHPCS into an ArcanistExternalLinter linter.
# Add test coverage for PHPCS.
# Add a `severity.rules` option to `.arclint`. Some linters have very explicit builtin severities ("error", "warning") but their meanings are different from how arc interprets these terms. For example, PHPCS raises "wrong indentation level" as an "error". You can already use the "severity" map to adjust individual rules, but if you want to adjust an entire linter it's currently difficult. This rule map makes it easy. There's substantial precedent for this in other linters, notably all the Python linters.
For `severity.rules`, for example, this will turn all PHPCS "errors" into warnings, and all of its warnings into advice:
"severity.rules" : {
"(^PHPCS\\.E\\.)" : "warning",
"(^PHPCS\\.W\\.)" : "advice"
}
The user can use `severity` (or more rules) to get additional granularity adjustments if they desire.
Test Plan: 5bb919bc3a
Reviewers: btrahan
Reviewed By: btrahan
CC: aran, ajtrichards
Maniphest Tasks: T2039, T3186, T3771
Differential Revision: https://secure.phabricator.com/D6830
118 lines
2.9 KiB
PHP
118 lines
2.9 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Uses "PHP_CodeSniffer" to detect checkstyle errors in php code.
|
|
* To use this linter, you must install PHP_CodeSniffer.
|
|
* http://pear.php.net/package/PHP_CodeSniffer.
|
|
*
|
|
* Optional configurations in .arcconfig:
|
|
*
|
|
* lint.phpcs.standard
|
|
* lint.phpcs.options
|
|
* lint.phpcs.bin
|
|
*
|
|
* @group linter
|
|
*/
|
|
final class ArcanistPhpcsLinter extends ArcanistExternalLinter {
|
|
|
|
private $reports;
|
|
|
|
public function getLinterName() {
|
|
return 'PHPCS';
|
|
}
|
|
|
|
public function getLinterConfigurationName() {
|
|
return 'phpcs';
|
|
}
|
|
|
|
public function getMandatoryFlags() {
|
|
return '--report=xml';
|
|
}
|
|
|
|
public function getInstallInstructions() {
|
|
return pht('Install PHPCS with `pear install PHP_CodeSniffer`.');
|
|
}
|
|
|
|
public function getDefaultFlags() {
|
|
// TODO: Deprecation warnings.
|
|
|
|
$working_copy = $this->getEngine()->getWorkingCopy();
|
|
|
|
$options = $working_copy->getConfig('lint.phpcs.options');
|
|
|
|
$standard = $working_copy->getConfig('lint.phpcs.standard');
|
|
$options .= !empty($standard) ? ' --standard=' . $standard : '';
|
|
|
|
return $options;
|
|
}
|
|
|
|
public function getDefaultBinary() {
|
|
// TODO: Deprecation warnings.
|
|
$working_copy = $this->getEngine()->getWorkingCopy();
|
|
$bin = $working_copy->getConfig('lint.phpcs.bin');
|
|
if ($bin) {
|
|
return $bin;
|
|
}
|
|
|
|
return 'phpcs';
|
|
}
|
|
|
|
public function shouldExpectCommandErrors() {
|
|
return true;
|
|
}
|
|
|
|
protected function parseLinterOutput($path, $err, $stdout, $stderr) {
|
|
$report_dom = new DOMDocument();
|
|
$ok = @$report_dom->loadXML($stdout);
|
|
if (!$ok) {
|
|
return false;
|
|
}
|
|
|
|
$files = $report_dom->getElementsByTagName('file');
|
|
$messages = array();
|
|
foreach ($files as $file) {
|
|
foreach ($file->childNodes as $child) {
|
|
if (!($child instanceof DOMElement)) {
|
|
continue;
|
|
}
|
|
|
|
if ($child->tagName == 'error') {
|
|
$prefix = 'E';
|
|
} else {
|
|
$prefix = 'W';
|
|
}
|
|
|
|
$code = 'PHPCS.'.$prefix.'.'.$child->getAttribute('source');
|
|
|
|
$message = new ArcanistLintMessage();
|
|
$message->setPath($path);
|
|
$message->setLine($child->getAttribute('line'));
|
|
$message->setChar($child->getAttribute('column'));
|
|
$message->setCode($code);
|
|
$message->setDescription($child->nodeValue);
|
|
$message->setSeverity($this->getLintMessageSeverity($code));
|
|
|
|
$messages[] = $message;
|
|
}
|
|
}
|
|
|
|
return $messages;
|
|
}
|
|
|
|
protected function getDefaultMessageSeverity($code) {
|
|
if (preg_match('/^PHPCS\\.W\\./', $code)) {
|
|
return ArcanistLintSeverity::SEVERITY_WARNING;
|
|
} else {
|
|
return ArcanistLintSeverity::SEVERITY_ERROR;
|
|
}
|
|
}
|
|
|
|
protected function getLintCodeFromLinterConfigurationKey($code) {
|
|
if (!preg_match('/^PHPCS\\.(E|W)\\./', $code)) {
|
|
throw new Exception(
|
|
"Invalid severity code '{$code}', should begin with 'PHPCS.'.");
|
|
}
|
|
return $code;
|
|
}
|
|
|
|
}
|