1<?php
2/**
3 * Squiz_Sniffs_Debug_JSLintSniff.
4 *
5 * PHP version 5
6 *
7 * @category  PHP
8 * @package   PHP_CodeSniffer
9 * @author    Greg Sherwood <gsherwood@squiz.net>
10 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
11 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
12 * @link      http://pear.php.net/package/PHP_CodeSniffer
13 */
14
15/**
16 * Squiz_Sniffs_Debug_JSLintSniff.
17 *
18 * Runs jslint.js on the file.
19 *
20 * @category  PHP
21 * @package   PHP_CodeSniffer
22 * @author    Greg Sherwood <gsherwood@squiz.net>
23 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
24 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
25 * @version   Release: @package_version@
26 * @link      http://pear.php.net/package/PHP_CodeSniffer
27 */
28class Squiz_Sniffs_Debug_JSLintSniff implements PHP_CodeSniffer_Sniff
29{
30
31    /**
32     * A list of tokenizers this sniff supports.
33     *
34     * @var array
35     */
36    public $supportedTokenizers = array('JS');
37
38
39    /**
40     * Returns the token types that this sniff is interested in.
41     *
42     * @return int[]
43     */
44    public function register()
45    {
46        return array(T_OPEN_TAG);
47
48    }//end register()
49
50
51    /**
52     * Processes the tokens that this sniff is interested in.
53     *
54     * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found.
55     * @param int                  $stackPtr  The position in the stack where
56     *                                        the token was found.
57     *
58     * @return void
59     * @throws PHP_CodeSniffer_Exception If jslint.js could not be run
60     */
61    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
62    {
63        $fileName = $phpcsFile->getFilename();
64
65        $rhinoPath  = PHP_CodeSniffer::getConfigData('rhino_path');
66        $jslintPath = PHP_CodeSniffer::getConfigData('jslint_path');
67        if ($rhinoPath === null || $jslintPath === null) {
68            return;
69        }
70
71        $rhinoPath  = escapeshellcmd($rhinoPath);
72        $jslintPath = escapeshellcmd($jslintPath);
73
74        $cmd = "$rhinoPath \"$jslintPath\" ".escapeshellarg($fileName);
75        $msg = exec($cmd, $output, $retval);
76
77        if (is_array($output) === true) {
78            foreach ($output as $finding) {
79                $matches    = array();
80                $numMatches = preg_match('/Lint at line ([0-9]+).*:(.*)$/', $finding, $matches);
81                if ($numMatches === 0) {
82                    continue;
83                }
84
85                $line    = (int) $matches[1];
86                $message = 'jslint says: '.trim($matches[2]);
87                $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool');
88            }
89        }
90
91        // Ignore the rest of the file.
92        return ($phpcsFile->numTokens + 1);
93
94    }//end process()
95
96
97}//end class
98