Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. JSHintSniff.php

class JSHintSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Generic\Sniffs\Debug\JSHintSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of JSHintSniff

File

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

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Debug
View source
class JSHintSniff 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 jshint.js could not be run.
     */
    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;
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
JSHintSniff::$supportedTokenizers public property A list of tokenizers this sniff supports.
JSHintSniff::process public function Processes the tokens that this sniff is interested in. Overrides Sniff::process
JSHintSniff::register public function Returns the token types that this sniff is interested in. Overrides Sniff::register
RSS feed
Powered by Drupal