Skip to content

Suggest sniff code if invalid #2646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Suggest sniff code if invalid #2646

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72874de
Suggest sniff code if invalid
Oct 11, 2019
e9fc07a
Fix phpcs errors
Oct 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/Config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -834,6 +834,7 @@ public function processLongArgument($arg, $pos)
foreach ($sniffs as $sniff) {
if (substr_count($sniff, '.') !== 2) {
$error = 'ERROR: The specified sniff code "'.$sniff.'" is invalid'.PHP_EOL.PHP_EOL;
$error .= 'Perhaps try following sniff code: '.$this->getSuggestedSniffCode($sniff).PHP_EOL.PHP_EOL;
$error .= $this->printShortUsage(true);
throw new DeepExitException($error, 3);
}
Expand All @@ -850,6 +851,7 @@ public function processLongArgument($arg, $pos)
foreach ($sniffs as $sniff) {
if (substr_count($sniff, '.') !== 2) {
$error = 'ERROR: The specified sniff code "'.$sniff.'" is invalid'.PHP_EOL.PHP_EOL;
$error .= 'Perhaps try following sniff code: '.$this->getSuggestedSniffCode($sniff).PHP_EOL.PHP_EOL;
$error .= $this->printShortUsage(true);
throw new DeepExitException($error, 3);
}
Expand Down Expand Up @@ -1354,6 +1356,23 @@ public function printShortUsage($return=false)
}//end printShortUsage()


/**
* Suggest a sniff code by only combining first three elements.
*
* @param string $sniff Sniff code
*
* @return string
*/
public function getSuggestedSniffCode($sniff)
{
$elements = explode('.', $sniff);
$elements = array_slice($elements, 0, 3);

return implode('.', $elements);

}//end getSuggestedSniffCode()


/**
* Prints out the usage information for PHPCS.
*
Expand Down