Source for file ClosureLinterSniff.php
Documentation is available at ClosureLinterSniff.php
* Runs gjslint on the file.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Generic\Sniffs\Debug;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Config;
class ClosureLinterSniff implements Sniff
* A list of error codes that should show errors.
* All other error codes will show warnings.
public $errorCodes = array ();
* A list of error codes to ignore.
public $ignoreCodes = array ();
* A list of tokenizers this sniff supports.
public $supportedTokenizers = array ('JS');
* Returns the token types that this sniff is interested in.
public function register ()
return array (T_OPEN_TAG );
* 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
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException If jslint.js could not be run
public function process (File $phpcsFile, $stackPtr)
$lintPath = Config ::getExecutablePath ('gjslint');
if ($lintPath === null ) {
$fileName = $phpcsFile->getFilename ();
$cmd = '$lintPath --nosummary --notime --unix_mode '. escapeshellarg($fileName);
$msg = exec($cmd, $output, $retval);
foreach ($output as $finding) {
$numMatches = preg_match('/^(.*):([0-9]+):\(.*?([0-9]+)\)(.*)$/', $finding, $matches);
// Skip error codes we are ignoring.
if (in_array($code, $this->ignoreCodes) === true ) {
$line = (int) $matches[2 ];
$error = trim($matches[4 ]);
$message = 'gjslint says: (%s) %s';
if (in_array($code, $this->errorCodes) === true ) {
$phpcsFile->addErrorOnLine ($message, $line, 'ExternalToolError', $data);
$phpcsFile->addWarningOnLine ($message, $line, 'ExternalTool', $data);
// Ignore the rest of the file.
return ($phpcsFile->numTokens + 1 );
Documentation generated on Mon, 11 Mar 2019 15:27:18 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|