-
Notifications
You must be signed in to change notification settings - Fork 159
/
Copy pathSelectorDelimiterSniff.php
90 lines (77 loc) · 2.7 KB
/
SelectorDelimiterSniff.php
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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Less;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
/**
* Class SelectorDelimiterSniff
*
* Ensure that a line break exists after each selector delimiter.
* No spaces should be before or after delimiters.
*
* @link https://devdocs.magento.com/guides/v2.4/coding-standards/code-standard-less.html#selector-delimiters
*/
class SelectorDelimiterSniff implements Sniff
{
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = [TokenizerSymbolsInterface::TOKENIZER_CSS];
/**
* @inheritdoc
*/
public function register()
{
return [T_COMMA];
}
/**
* @inheritdoc
*/
public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
// Check that there's no spaces before delimiter
if ($tokens[$stackPtr - 1]['code'] === T_WHITESPACE) {
$phpcsFile->addError('Spaces should not be before delimiter', $stackPtr - 1, 'SpacesBeforeDelimiter');
}
$this->validateParenthesis($phpcsFile, $stackPtr, $tokens);
}
/**
* Parenthesis validation.
*
* @param File $phpcsFile
* @param int $stackPtr
* @param array $tokens
* @return void
*/
private function validateParenthesis(File $phpcsFile, $stackPtr, array $tokens)
{
$nextPtr = $stackPtr + 1;
$nextClassPtr = $phpcsFile->findNext(T_STRING_CONCAT, $nextPtr);
$nextOpenBrace = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, $nextPtr);
if ($nextClassPtr === false || $nextOpenBrace === false) {
return;
}
$stackLine = $tokens[$stackPtr]['line'];
$nextClassLine = $tokens[$nextPtr]['line'];
$nextOpenBraceLine = $tokens[$nextOpenBrace]['line'];
// Check that each class declaration goes from new line
if (($stackLine === $nextClassLine) && ($stackLine === $nextOpenBraceLine)) {
$prevParenthesis = $phpcsFile->findPrevious(T_OPEN_PARENTHESIS, $stackPtr);
$nextParenthesis = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
if ((false !== $prevParenthesis) && (false !== $nextParenthesis)
&& ($tokens[$prevParenthesis]['line'] === $tokens[$stackPtr]['line'])
&& ($tokens[$nextParenthesis]['line'] === $tokens[$stackPtr]['line'])
) {
return;
}
$error = 'Add a line break after each selector delimiter';
$phpcsFile->addError($error, $nextOpenBrace, 'LineBreakAfterDelimiter');
}
}
}