← Back to branch summary

~ubuntu-branches/ubuntu/vivid/php-codesniffer/vivid

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.5/CodeSniffer/Standards/Squiz/Sniffs/Debug/JSLintSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot, Greg Sherwood, Alexey, Emily, David Prévot
  • Date: 2014-09-26 13:44:35 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140926134435-wvjq16miqq4d60y0
Tags: 1.5.5-1
[ Greg Sherwood ]
* Improved closure support in Generic ScopeIndentSniff
* Improved indented PHP tag support in Generic ScopeIndentSniff
* Standards can now be located within hidden directories
 (further fix for bug #20323)
* Fixed bug #20373 : Inline comment sniff tab handling way
* Fixed bug #20378 : Report appended to existing file if no errors
  found in run
* Fixed bug #20381 : Invalid "Comment closer must be on a new line"
* PHP tokenizer no longer converts class/function names to special
  tokens types
* Fixed bug #20386 : Squiz.Commenting.ClassComment.SpacingBefore
  thrown if first block comment
* Squiz and PEAR FunctionCommentSnif now support _()
* PEAR ValidFunctionNameSniff no longer throws an error for _()
* Fixed bug #248 : FunctionCommentSniff expects ampersand on param name
* Fixed bug #248 in Squiz sniff as well
* Fixed bug #265 : False positives with type hints in ForbiddenFunctionsSniff
* Prepare for 1.5.5 release

[ Alexey ]
* Allowed single undersored methods and functions

[ Emily ]
* Added var_dump to discouraged functions sniff

[ David Prévot ]
* Revert "Add XS-Testsuite still needed for ci.d.n"
* Add self to uploaders
* Bump standards version to 3.9.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.5.5/CodeSniffer/Standards/Squiz/Sniffs/Debug/JSLintSniff.php
 
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: 1.5.5
 
26
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
27
 */
 
28
class 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
        $cmd = "$rhinoPath \"$jslintPath\" \"$fileName\"";
 
72
        $msg = exec($cmd, $output, $retval);
 
73
 
 
74
        if (is_array($output) === true) {
 
75
            $tokens = $phpcsFile->getTokens();
 
76
 
 
77
            foreach ($output as $finding) {
 
78
                $matches    = array();
 
79
                $numMatches = preg_match('/Lint at line ([0-9]+).*:(.*)$/', $finding, $matches);
 
80
                if ($numMatches === 0) {
 
81
                    continue;
 
82
                }
 
83
 
 
84
                $line    = (int) $matches[1];
 
85
                $message = 'jslint says: '.trim($matches[2]);
 
86
 
 
87
                // Find the token at the start of the line.
 
88
                $lineToken = null;
 
89
                foreach ($tokens as $ptr => $info) {
 
90
                    if ($info['line'] === $line) {
 
91
                        $lineToken = $ptr;
 
92
                        break;
 
93
                    }
 
94
                }
 
95
 
 
96
                if ($lineToken !== null) {
 
97
                    $phpcsFile->addWarning($message, $lineToken, 'ExternalTool');
 
98
                }
 
99
            }//end foreach
 
100
        }//end if
 
101
 
 
102
    }//end process()
 
103
 
 
104
 
 
105
}//end class
 
106
 
 
107
?>