Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@17
|
3 * \Drupal\Sniffs\CSS\ClassDefinitionNameSpacingSniff.
|
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\CSS;
|
Chris@17
|
11
|
Chris@17
|
12 use PHP_CodeSniffer\Files\File;
|
Chris@17
|
13 use PHP_CodeSniffer\Sniffs\Sniff;
|
Chris@17
|
14 use PHP_CodeSniffer\Util\Tokens;
|
Chris@17
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * Ensure there are no blank lines between the names of classes/IDs. Copied from
|
Chris@17
|
18 * \PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS\ClassDefinitionNameSpacingSniff
|
Chris@17
|
19 * because we also check for comma separated selectors on their own line.
|
Chris@0
|
20 *
|
Chris@0
|
21 * @category PHP
|
Chris@0
|
22 * @package PHP_CodeSniffer
|
Chris@0
|
23 * @link http://pear.php.net/package/PHP_CodeSniffer
|
Chris@0
|
24 */
|
Chris@17
|
25 class ClassDefinitionNameSpacingSniff implements Sniff
|
Chris@0
|
26 {
|
Chris@0
|
27
|
Chris@0
|
28 /**
|
Chris@0
|
29 * A list of tokenizers this sniff supports.
|
Chris@0
|
30 *
|
Chris@0
|
31 * @var array
|
Chris@0
|
32 */
|
Chris@0
|
33 public $supportedTokenizers = array('CSS');
|
Chris@0
|
34
|
Chris@0
|
35
|
Chris@0
|
36 /**
|
Chris@0
|
37 * Returns the token types that this sniff is interested in.
|
Chris@0
|
38 *
|
Chris@0
|
39 * @return int[]
|
Chris@0
|
40 */
|
Chris@0
|
41 public function register()
|
Chris@0
|
42 {
|
Chris@0
|
43 return array(T_OPEN_CURLY_BRACKET);
|
Chris@0
|
44
|
Chris@0
|
45 }//end register()
|
Chris@0
|
46
|
Chris@0
|
47
|
Chris@0
|
48 /**
|
Chris@0
|
49 * Processes the tokens that this sniff is interested in.
|
Chris@0
|
50 *
|
Chris@17
|
51 * @param \PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found.
|
Chris@17
|
52 * @param int $stackPtr The position in the stack where
|
Chris@17
|
53 * the token was found.
|
Chris@0
|
54 *
|
Chris@0
|
55 * @return void
|
Chris@0
|
56 */
|
Chris@17
|
57 public function process(File $phpcsFile, $stackPtr)
|
Chris@0
|
58 {
|
Chris@0
|
59 $tokens = $phpcsFile->getTokens();
|
Chris@0
|
60
|
Chris@0
|
61 // Do not check nested style definitions as, for example, in @media style rules.
|
Chris@0
|
62 $nested = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($stackPtr + 1), $tokens[$stackPtr]['bracket_closer']);
|
Chris@0
|
63 if ($nested !== false) {
|
Chris@0
|
64 return;
|
Chris@0
|
65 }
|
Chris@0
|
66
|
Chris@0
|
67 // Find the first blank line before this opening brace, unless we get
|
Chris@0
|
68 // to another style definition, comment or the start of the file.
|
Chris@0
|
69 $endTokens = array(
|
Chris@0
|
70 T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET,
|
Chris@0
|
71 T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET,
|
Chris@0
|
72 T_OPEN_TAG => T_OPEN_TAG,
|
Chris@0
|
73 );
|
Chris@17
|
74 $endTokens += Tokens::$commentTokens;
|
Chris@0
|
75
|
Chris@0
|
76 $foundContent = false;
|
Chris@0
|
77 $currentLine = $tokens[$stackPtr]['line'];
|
Chris@0
|
78 for ($i = ($stackPtr - 1); $i >= 0; $i--) {
|
Chris@0
|
79 if (isset($endTokens[$tokens[$i]['code']]) === true) {
|
Chris@0
|
80 break;
|
Chris@0
|
81 }
|
Chris@0
|
82
|
Chris@0
|
83 // A comma must be followed by a new line character.
|
Chris@0
|
84 if ($tokens[$i]['code'] === T_COMMA
|
Chris@0
|
85 && strpos($tokens[($i + 1)]['content'], $phpcsFile->eolChar) === false
|
Chris@0
|
86 ) {
|
Chris@0
|
87 $error = 'Multiple selectors should each be on a single line';
|
Chris@0
|
88 $fix = $phpcsFile->addFixableError($error, ($i + 1), 'MultipleSelectors');
|
Chris@0
|
89 if ($fix === true) {
|
Chris@0
|
90 $phpcsFile->fixer->addNewline($i);
|
Chris@0
|
91 }
|
Chris@0
|
92 }
|
Chris@0
|
93
|
Chris@0
|
94 // Selectors must be on the same line.
|
Chris@0
|
95 if ($tokens[$i]['code'] === T_WHITESPACE
|
Chris@0
|
96 && strpos($tokens[$i]['content'], $phpcsFile->eolChar) !== false
|
Chris@0
|
97 && isset($endTokens[$tokens[($i - 1)]['code']]) === false
|
Chris@0
|
98 && in_array($tokens[($i - 1)]['code'], array(T_WHITESPACE, T_COMMA)) === false
|
Chris@0
|
99 ) {
|
Chris@0
|
100 $error = 'Selectors must be on a single line';
|
Chris@0
|
101 $fix = $phpcsFile->addFixableError($error, $i, 'SeletorSingleLine');
|
Chris@0
|
102 if ($fix === true) {
|
Chris@0
|
103 $phpcsFile->fixer->replaceToken($i, str_replace($phpcsFile->eolChar, ' ', $tokens[$i]['content']));
|
Chris@0
|
104 }
|
Chris@0
|
105 }
|
Chris@0
|
106
|
Chris@0
|
107 if ($tokens[$i]['line'] === $currentLine) {
|
Chris@0
|
108 if ($tokens[$i]['code'] !== T_WHITESPACE) {
|
Chris@0
|
109 $foundContent = true;
|
Chris@0
|
110 }
|
Chris@0
|
111
|
Chris@0
|
112 continue;
|
Chris@0
|
113 }
|
Chris@0
|
114
|
Chris@0
|
115 // We changed lines.
|
Chris@0
|
116 if ($foundContent === false) {
|
Chris@0
|
117 // Before we throw an error, make sure we are not looking
|
Chris@0
|
118 // at a gap before the style definition.
|
Chris@0
|
119 $prev = $phpcsFile->findPrevious(T_WHITESPACE, $i, null, true);
|
Chris@0
|
120 if ($prev !== false
|
Chris@0
|
121 && isset($endTokens[$tokens[$prev]['code']]) === false
|
Chris@0
|
122 ) {
|
Chris@0
|
123 $error = 'Blank lines are not allowed between class names';
|
Chris@0
|
124 $fix = $phpcsFile->addFixableError($error, ($i + 1), 'BlankLinesFound');
|
Chris@0
|
125 if ($fix === true) {
|
Chris@0
|
126 $phpcsFile->fixer->replaceToken(($i + 1), '');
|
Chris@0
|
127 }
|
Chris@0
|
128 }
|
Chris@0
|
129
|
Chris@0
|
130 break;
|
Chris@0
|
131 }
|
Chris@0
|
132
|
Chris@0
|
133 $foundContent = false;
|
Chris@0
|
134 $currentLine = $tokens[$i]['line'];
|
Chris@0
|
135 }//end for
|
Chris@0
|
136
|
Chris@0
|
137 }//end process()
|
Chris@0
|
138
|
Chris@0
|
139
|
Chris@0
|
140 }//end class
|