function JSHintSniff::process

Processes the tokens that this sniff is interested in.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found.:

int $stackPtr The position in the stack where: the token was found.

Return value

int

Throws

\PHP_CodeSniffer\Exceptions\RuntimeException If jshint.js could not be run.

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Debug/JSHintSniff.php, line 53

Class

JSHintSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Debug

Code

public function process(File $phpcsFile, $stackPtr) {
    $rhinoPath = Config::getExecutablePath('rhino');
    $jshintPath = Config::getExecutablePath('jshint');
    if ($jshintPath === null) {
        return $phpcsFile->numTokens;
    }
    $fileName = $phpcsFile->getFilename();
    $jshintPath = Common::escapeshellcmd($jshintPath);
    if ($rhinoPath !== null) {
        $rhinoPath = Common::escapeshellcmd($rhinoPath);
        $cmd = "{$rhinoPath} \"{$jshintPath}\" " . escapeshellarg($fileName);
        exec($cmd, $output, $retval);
        $regex = '`^(?P<error>.+)\\(.+:(?P<line>[0-9]+).*:[0-9]+\\)$`';
    }
    else {
        $cmd = "{$jshintPath} " . escapeshellarg($fileName);
        exec($cmd, $output, $retval);
        $regex = '`^(.+?): line (?P<line>[0-9]+), col [0-9]+, (?P<error>.+)$`';
    }
    if (is_array($output) === true) {
        foreach ($output as $finding) {
            $matches = [];
            $numMatches = preg_match($regex, $finding, $matches);
            if ($numMatches === 0) {
                continue;
            }
            $line = (int) $matches['line'];
            $message = 'jshint says: ' . trim($matches['error']);
            $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool');
        }
    }
    // Ignore the rest of the file.
    return $phpcsFile->numTokens;
}