class JavaScriptLintSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Squiz\Sniffs\Debug\JavaScriptLintSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of JavaScriptLintSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Squiz/ Sniffs/ Debug/ JavaScriptLintSniff.php, line 20
Namespace
PHP_CodeSniffer\Standards\Squiz\Sniffs\DebugView source
class JavaScriptLintSniff implements Sniff {
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = [
'JS',
];
/**
* Returns the token types that this sniff is interested in.
*
* @return array<int|string>
*/
public function register() {
return [
T_OPEN_TAG,
];
}
//end register()
/**
* Processes the tokens that this sniff is interested in.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found.
* @param int $stackPtr The position in the stack where
* the token was found.
*
* @return int
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If Javascript Lint ran into trouble.
*/
public function process(File $phpcsFile, $stackPtr) {
$jslPath = Config::getExecutablePath('jsl');
if ($jslPath === null) {
return $phpcsFile->numTokens;
}
$fileName = $phpcsFile->getFilename();
$cmd = '"' . Common::escapeshellcmd($jslPath) . '" -nologo -nofilelisting -nocontext -nosummary -output-format __LINE__:__ERROR__ -process ' . escapeshellarg($fileName);
$msg = exec($cmd, $output, $retval);
// Variable $exitCode is the last line of $output if no error occurs, on
// error it is numeric. Try to handle various error conditions and
// provide useful error reporting.
if ($retval === 2 || $retval === 4) {
if (is_array($output) === true) {
$msg = implode('\\n', $output);
}
throw new RuntimeException("Failed invoking JavaScript Lint, retval was [{$retval}], output was [{$msg}]");
}
if (is_array($output) === true) {
foreach ($output as $finding) {
$split = strpos($finding, ':');
$line = substr($finding, 0, $split);
$message = substr($finding, $split + 1);
$phpcsFile->addWarningOnLine(trim($message), $line, 'ExternalTool');
}
}
// Ignore the rest of the file.
return $phpcsFile->numTokens;
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
JavaScriptLintSniff::$supportedTokenizers | public | property | A list of tokenizers this sniff supports. | |
JavaScriptLintSniff::process | public | function | Processes the tokens that this sniff is interested in. | Overrides Sniff::process |
JavaScriptLintSniff::register | public | function | Returns the token types that this sniff is interested in. | Overrides Sniff::register |