1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sniffs\Less;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
/**
* Class CommentLevelsSniff
*
* First and second level comments must be surrounded by empty lines.
* First, second and third level comments should have two spaces after "//".
* Inline comments should have one space after "//".
*
* @link https://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-less.html#comments
*/
class CommentLevelsSniff implements Sniff
{
const COMMENT_STRING = '//';
const FIRST_LEVEL_COMMENT = '_____________________________________________';
const SECOND_LEVEL_COMMENT = '--';
/**
* @var array
*/
protected $levelComments = [
self::FIRST_LEVEL_COMMENT => T_STRING,
self::SECOND_LEVEL_COMMENT => T_DEC,
];
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS];
/**
* @inheritdoc
*/
public function register()
{
return [T_STRING];
}
/**
* @inheritdoc
*/
public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
if ((T_STRING !== $tokens[$stackPtr]['code'])
|| (self::COMMENT_STRING !== $tokens[$stackPtr]['content'])
|| (1 === $tokens[$stackPtr]['line'])
) {
return;
}
$textInSameLine = $phpcsFile->findPrevious([T_STRING, T_STYLE], $stackPtr - 1);
// is inline comment
if ((false !== $textInSameLine)
&& ($tokens[$textInSameLine]['line'] === $tokens[$stackPtr]['line'])
) {
$this->validateInlineComment($phpcsFile, $stackPtr, $tokens);
return;
}
// validation of levels comments
if (!in_array($tokens[$stackPtr + 1]['content'], [
TokenizerSymbolsInterface::DOUBLE_WHITESPACE,
TokenizerSymbolsInterface::NEW_LINE,
])
) {
$phpcsFile->addError('Level\'s comment does not have 2 spaces after "//"', $stackPtr, 'SpacesMissed');
}
if (!$this->isNthLevelComment($phpcsFile, $stackPtr, $tokens)) {
return;
}
if (!$this->checkNthLevelComment($phpcsFile, $stackPtr, $tokens)) {
$phpcsFile->addError(
'First and second level comments must be surrounded by empty lines',
$stackPtr,
'SpaceMissed'
);
}
}
/**
* Validate that inline comment responds to given requirements
*
* @param File $phpcsFile
* @param int $stackPtr
* @param array $tokens
* @return bool
*/
private function validateInlineComment(File $phpcsFile, $stackPtr, array $tokens)
{
if ($tokens[$stackPtr + 1]['content'] !== TokenizerSymbolsInterface::WHITESPACE) {
$phpcsFile->addError('Inline comment should have 1 space after "//"', $stackPtr, 'SpaceMissedAfter');
}
if ($tokens[$stackPtr - 1]['content'] !== TokenizerSymbolsInterface::WHITESPACE) {
$phpcsFile->addError('Inline comment should have 1 space before "//"', $stackPtr, 'SpaceMissedBefore');
}
}
/**
* Check is it n-th level comment was found
*
* @param File $phpcsFile
* @param int $stackPtr
* @param array $tokens
* @return bool
*/
private function isNthLevelComment(File $phpcsFile, $stackPtr, array $tokens)
{
$nthLevelCommentFound = false;
$levelComment = 0;
foreach ($this->levelComments as $code => $comment) {
$levelComment = $phpcsFile->findNext($comment, $stackPtr, null, false, $code);
if (false !== $levelComment) {
$nthLevelCommentFound = true;
break;
}
}
if (false === $nthLevelCommentFound) {
return false;
}
$currentLine = $tokens[$stackPtr]['line'];
$levelCommentLine = $tokens[$levelComment]['line'];
if ($currentLine !== $levelCommentLine) {
return false;
}
return true;
}
/**
* Check is it n-th level comment is correct
*
* @param File $phpcsFile
* @param int $stackPtr
* @param array $tokens
* @return bool
*/
private function checkNthLevelComment(File $phpcsFile, $stackPtr, array $tokens)
{
$correct = false;
$nextLine = $phpcsFile->findNext(
T_WHITESPACE,
$stackPtr,
null,
false,
TokenizerSymbolsInterface::NEW_LINE
);
if (false === $nextLine) {
return $correct;
}
if (($tokens[$nextLine]['content'] !== TokenizerSymbolsInterface::NEW_LINE)
|| ($tokens[$nextLine + 1]['content'] !== TokenizerSymbolsInterface::NEW_LINE)
) {
return $correct;
}
$commentLinePtr = $stackPtr;
while ($tokens[$commentLinePtr - 2]['line'] > 1) {
$commentLinePtr = $phpcsFile->findPrevious(T_STRING, $commentLinePtr - 1, null, false, '//');
if (false === $commentLinePtr) {
continue;
}
if (($tokens[$commentLinePtr - 1]['content'] === TokenizerSymbolsInterface::NEW_LINE)
&& ($tokens[$commentLinePtr - 2]['content'] === TokenizerSymbolsInterface::NEW_LINE)
) {
$correct = true;
break;
}
}
return $correct;
}
}