Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\WhiteSpace\EmptyLinesSniff.
|
Chris@0
|
4 *
|
Chris@0
|
5 * @category PHP
|
Chris@0
|
6 * @package PHP_CodeSniffer
|
Chris@0
|
7 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@17
|
10 namespace Drupal\Sniffs\WhiteSpace;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14
|
Chris@0
|
15 /**
|
Chris@17
|
16 * \Drupal\Sniffs\WhiteSpace\EmptyLinesSniff.
|
Chris@0
|
17 *
|
Chris@0
|
18 * Checks that there are not more than 2 empty lines following each other.
|
Chris@0
|
19 *
|
Chris@0
|
20 * @category PHP
|
Chris@0
|
21 * @package PHP_CodeSniffer
|
Chris@0
|
22 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
23 */
|
Chris@17
|
24 class EmptyLinesSniff implements Sniff
|
Chris@0
|
25 {
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * A list of tokenizers this sniff supports.
|
Chris@0
|
29 *
|
Chris@0
|
30 * @var array
|
Chris@0
|
31 */
|
Chris@0
|
32 public $supportedTokenizers = array(
|
Chris@0
|
33 'PHP',
|
Chris@0
|
34 'JS',
|
Chris@0
|
35 'CSS',
|
Chris@0
|
36 );
|
Chris@0
|
37
|
Chris@0
|
38
|
Chris@0
|
39 /**
|
Chris@0
|
40 * Returns an array of tokens this test wants to listen for.
|
Chris@0
|
41 *
|
Chris@0
|
42 * @return array
|
Chris@0
|
43 */
|
Chris@0
|
44 public function register()
|
Chris@0
|
45 {
|
Chris@0
|
46 return array(T_WHITESPACE);
|
Chris@0
|
47
|
Chris@0
|
48 }//end register()
|
Chris@0
|
49
|
Chris@0
|
50
|
Chris@0
|
51 /**
|
Chris@0
|
52 * Processes this test, when one of its tokens is encountered.
|
Chris@0
|
53 *
|
Chris@17
|
54 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
|
Chris@17
|
55 * @param int $stackPtr The position of the current token
|
Chris@17
|
56 * in the stack passed in $tokens.
|
Chris@0
|
57 *
|
Chris@0
|
58 * @return void
|
Chris@0
|
59 */
|
Chris@17
|
60 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
61 {
|
Chris@0
|
62 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
63 if ($tokens[$stackPtr]['content'] === $phpcsFile->eolChar
|
Chris@0
|
64 && isset($tokens[($stackPtr + 1)]) === true
|
Chris@0
|
65 && $tokens[($stackPtr + 1)]['content'] === $phpcsFile->eolChar
|
Chris@0
|
66 && isset($tokens[($stackPtr + 2)]) === true
|
Chris@0
|
67 && $tokens[($stackPtr + 2)]['content'] === $phpcsFile->eolChar
|
Chris@0
|
68 && isset($tokens[($stackPtr + 3)]) === true
|
Chris@0
|
69 && $tokens[($stackPtr + 3)]['content'] === $phpcsFile->eolChar
|
Chris@0
|
70 ) {
|
Chris@0
|
71 $error = 'More than 2 empty lines are not allowed';
|
Chris@0
|
72 $phpcsFile->addError($error, ($stackPtr + 3), 'EmptyLines');
|
Chris@0
|
73 }
|
Chris@0
|
74
|
Chris@0
|
75 }//end process()
|
Chris@0
|
76
|
Chris@0
|
77
|
Chris@0
|
78 }//end class
|