-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
NoTrailingCommaInSinglelineFixer.php
149 lines (120 loc) · 5.51 KB
/
NoTrailingCommaInSinglelineFixer.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
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
<?php
declare(strict_types=1);
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer\Fixer\Basic;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\FixerConfiguration\AllowedValueSubset;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Analyzer\AttributeAnalyzer;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Tokens;
final class NoTrailingCommaInSinglelineFixer extends AbstractFixer implements ConfigurableFixerInterface
{
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma.',
[
new CodeSample("<?php\nfoo(\$a,);\n\$foo = array(1,);\n[\$foo, \$bar,] = \$array;\nuse a\\{ClassA, ClassB,};\n"),
new CodeSample("<?php\nfoo(\$a,);\n[\$foo, \$bar,] = \$array;\n", ['elements' => ['array_destructuring']]),
]
);
}
public function isCandidate(Tokens $tokens): bool
{
return
$tokens->isTokenKindFound(',')
&& $tokens->isAnyTokenKindsFound([')', CT::T_ARRAY_SQUARE_BRACE_CLOSE, CT::T_DESTRUCTURING_SQUARE_BRACE_CLOSE, CT::T_GROUP_IMPORT_BRACE_CLOSE]);
}
protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
{
$elements = ['arguments', 'array_destructuring', 'array', 'group_import'];
return new FixerConfigurationResolver([
(new FixerOptionBuilder('elements', 'Which elements to fix.'))
->setAllowedTypes(['array'])
->setAllowedValues([new AllowedValueSubset($elements)])
->setDefault($elements)
->getOption(),
]);
}
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
for ($index = $tokens->count() - 1; $index >= 0; --$index) {
if (!$tokens[$index]->equals(')') && !$tokens[$index]->isGivenKind([CT::T_ARRAY_SQUARE_BRACE_CLOSE, CT::T_DESTRUCTURING_SQUARE_BRACE_CLOSE, CT::T_GROUP_IMPORT_BRACE_CLOSE])) {
continue;
}
$commaIndex = $tokens->getPrevMeaningfulToken($index);
if (!$tokens[$commaIndex]->equals(',')) {
continue;
}
$block = Tokens::detectBlockType($tokens[$index]);
$blockOpenIndex = $tokens->findBlockStart($block['type'], $index);
if ($tokens->isPartialCodeMultiline($blockOpenIndex, $index)) {
continue;
}
if (!$this->shouldBeCleared($tokens, $blockOpenIndex)) {
continue;
}
do {
$tokens->clearTokenAndMergeSurroundingWhitespace($commaIndex);
$commaIndex = $tokens->getPrevMeaningfulToken($commaIndex);
} while ($tokens[$commaIndex]->equals(','));
$tokens->removeTrailingWhitespace($commaIndex);
}
}
private function shouldBeCleared(Tokens $tokens, int $openIndex): bool
{
/** @var list<string> $elements */
$elements = $this->configuration['elements'];
if ($tokens[$openIndex]->isGivenKind(CT::T_ARRAY_SQUARE_BRACE_OPEN)) {
return \in_array('array', $elements, true);
}
if ($tokens[$openIndex]->isGivenKind(CT::T_DESTRUCTURING_SQUARE_BRACE_OPEN)) {
return \in_array('array_destructuring', $elements, true);
}
if ($tokens[$openIndex]->isGivenKind(CT::T_GROUP_IMPORT_BRACE_OPEN)) {
return \in_array('group_import', $elements, true);
}
if (!$tokens[$openIndex]->equals('(')) {
return false;
}
$beforeOpen = $tokens->getPrevMeaningfulToken($openIndex);
if ($tokens[$beforeOpen]->isGivenKind(T_ARRAY)) {
return \in_array('array', $elements, true);
}
if ($tokens[$beforeOpen]->isGivenKind(T_LIST)) {
return \in_array('array_destructuring', $elements, true);
}
if ($tokens[$beforeOpen]->isGivenKind([T_UNSET, T_ISSET, T_VARIABLE, T_CLASS])) {
return \in_array('arguments', $elements, true);
}
if ($tokens[$beforeOpen]->isGivenKind(T_STRING)) {
return !AttributeAnalyzer::isAttribute($tokens, $beforeOpen) && \in_array('arguments', $elements, true);
}
if ($tokens[$beforeOpen]->equalsAny([')', ']', [CT::T_DYNAMIC_VAR_BRACE_CLOSE], [CT::T_ARRAY_INDEX_CURLY_BRACE_CLOSE]])) {
$block = Tokens::detectBlockType($tokens[$beforeOpen]);
return
(
Tokens::BLOCK_TYPE_ARRAY_INDEX_CURLY_BRACE === $block['type']
|| Tokens::BLOCK_TYPE_DYNAMIC_VAR_BRACE === $block['type']
|| Tokens::BLOCK_TYPE_INDEX_SQUARE_BRACE === $block['type']
|| Tokens::BLOCK_TYPE_PARENTHESIS_BRACE === $block['type']
) && \in_array('arguments', $elements, true);
}
return false;
}
}