Skip to content

Commit f17b84d

Browse files
TomasVotrubaTomasVotruba
committed
remove in-code documentation, use README
1 parent 560ad04 commit f17b84d

14 files changed

+14
-333
lines changed

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"require-dev": {
1212
"symplify/easy-coding-standard": "^12.5",
1313
"squizlabs/php_codesniffer": "^3.12",
14-
"phpunit/phpunit": "^11.0",
14+
"phpunit/phpunit": "^11.5",
1515
"phpstan/extension-installer": "^1.4",
1616
"phpstan/phpstan": "^2.1",
1717
"rector/rector": "^2.0",

‎src/Fixer/Annotation/RemovePHPStormAnnotationFixer.php‎

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,11 @@
1212
use SplFileInfo;
1313
use Symplify\CodingStandard\Fixer\AbstractSymplifyFixer;
1414
use Symplify\CodingStandard\TokenRunner\Traverser\TokenReverser;
15-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
16-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
17-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
1815

1916
/**
2017
* @see \Symplify\CodingStandard\Tests\Fixer\Annotation\RemovePHPStormAnnotationFixer\RemovePHPStormAnnotationFixerTest
2118
*/
22-
final class RemovePHPStormAnnotationFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
19+
final class RemovePHPStormAnnotationFixer extends AbstractSymplifyFixer
2320
{
2421
/**
2522
* @see https://regex101.com/r/nGZBzj/2
@@ -72,29 +69,4 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
7269
$tokens->clearAt($index);
7370
}
7471
}
75-
76-
public function getRuleDefinition(): RuleDefinition
77-
{
78-
return new RuleDefinition(self::ERROR_MESSAGE, [
79-
new CodeSample(
80-
<<<'CODE_SAMPLE'
81-
/**
82-
* Created by PhpStorm.
83-
* User: ...
84-
* Date: 17/10/17
85-
* Time: 8:50 AM
86-
*/
87-
class SomeClass
88-
{
89-
}
90-
CODE_SAMPLE
91-
,
92-
<<<'CODE_SAMPLE'
93-
class SomeClass
94-
{
95-
}
96-
CODE_SAMPLE
97-
),
98-
]);
99-
}
10072
}

‎src/Fixer/ArrayNotation/ArrayListItemNewlineFixer.php‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,11 @@
1414
use Symplify\CodingStandard\TokenRunner\Arrays\ArrayItemNewliner;
1515
use Symplify\CodingStandard\TokenRunner\Traverser\ArrayBlockInfoFinder;
1616
use Symplify\CodingStandard\TokenRunner\ValueObject\TokenKinds;
17-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
18-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
19-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
2017

2118
/**
2219
* @see \Symplify\CodingStandard\Tests\Fixer\ArrayNotation\ArrayListItemNewlineFixer\ArrayListItemNewlineFixerTest
2320
*/
24-
final class ArrayListItemNewlineFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
21+
final class ArrayListItemNewlineFixer extends AbstractSymplifyFixer
2522
{
2623
/**
2724
* @var string
@@ -71,20 +68,4 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
7168
$this->arrayItemNewliner->fixArrayOpener($tokens, $arrayBlockInfo);
7269
}
7370
}
74-
75-
public function getRuleDefinition(): RuleDefinition
76-
{
77-
return new RuleDefinition(self::ERROR_MESSAGE, [
78-
new CodeSample(
79-
<<<'CODE_SAMPLE'
80-
$value = ['simple' => 1, 'easy' => 2];
81-
CODE_SAMPLE
82-
,
83-
<<<'CODE_SAMPLE'
84-
$value = ['simple' => 1,
85-
'easy' => 2];
86-
CODE_SAMPLE
87-
),
88-
]);
89-
}
9071
}

‎src/Fixer/ArrayNotation/ArrayOpenerAndCloserNewlineFixer.php‎

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,11 @@
1616
use Symplify\CodingStandard\TokenRunner\Traverser\ArrayBlockInfoFinder;
1717
use Symplify\CodingStandard\TokenRunner\ValueObject\TokenKinds;
1818
use Symplify\CodingStandard\ValueObject\BlockInfoMetadata;
19-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
20-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
21-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
2219

2320
/**
2421
* @see \Symplify\CodingStandard\Tests\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer\ArrayOpenerAndCloserNewlineFixerTest
2522
*/
26-
final class ArrayOpenerAndCloserNewlineFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
23+
final class ArrayOpenerAndCloserNewlineFixer extends AbstractSymplifyFixer
2724
{
2825
/**
2926
* @var string
@@ -52,23 +49,6 @@ public function getPriority(): int
5249
return 34;
5350
}
5451

55-
public function getRuleDefinition(): RuleDefinition
56-
{
57-
return new RuleDefinition(self::ERROR_MESSAGE, [
58-
new CodeSample(
59-
<<<'CODE_SAMPLE'
60-
$items = [1 => 'Hey'];
61-
CODE_SAMPLE
62-
,
63-
<<<'CODE_SAMPLE'
64-
$items = [
65-
1 => 'Hey'
66-
];
67-
CODE_SAMPLE
68-
),
69-
]);
70-
}
71-
7252
/**
7353
* @param Tokens<Token> $tokens
7454
*/

‎src/Fixer/ArrayNotation/StandaloneLineInMultilineArrayFixer.php‎

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,11 @@
1616
use Symplify\CodingStandard\TokenRunner\ValueObject\BlockInfo;
1717
use Symplify\CodingStandard\TokenRunner\ValueObject\TokenKinds;
1818
use Symplify\CodingStandard\TokenRunner\Wrapper\FixerWrapper\ArrayWrapperFactory;
19-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
20-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
21-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
2219

2320
/**
2421
* @see \Symplify\CodingStandard\Tests\Fixer\ArrayNotation\StandaloneLineInMultilineArrayFixer\StandaloneLineInMultilineArrayFixerTest
2522
*/
26-
final class StandaloneLineInMultilineArrayFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
23+
final class StandaloneLineInMultilineArrayFixer extends AbstractSymplifyFixer
2724
{
2825
/**
2926
* @var string
@@ -52,24 +49,6 @@ public function getPriority(): int
5249
return 5;
5350
}
5451

55-
public function getRuleDefinition(): RuleDefinition
56-
{
57-
return new RuleDefinition(self::ERROR_MESSAGE, [
58-
new CodeSample(
59-
<<<'CODE_SAMPLE'
60-
$friends = [1 => 'Peter', 2 => 'Paul'];
61-
CODE_SAMPLE
62-
,
63-
<<<'CODE_SAMPLE'
64-
$friends = [
65-
1 => 'Peter',
66-
2 => 'Paul'
67-
];
68-
CODE_SAMPLE
69-
),
70-
]);
71-
}
72-
7352
/**
7453
* @param Tokens<Token> $tokens
7554
*/

‎src/Fixer/Commenting/ParamReturnAndVarTagMalformsFixer.php‎

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,11 @@
2222
use Symplify\CodingStandard\TokenRunner\DocBlock\MalformWorker\SuperfluousVarNameMalformWorker;
2323
use Symplify\CodingStandard\TokenRunner\DocBlock\MalformWorker\SwitchedTypeAndNameMalformWorker;
2424
use Symplify\CodingStandard\TokenRunner\Traverser\TokenReverser;
25-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
26-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
27-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
2825

2926
/**
3027
* @see \Symplify\CodingStandard\Tests\Fixer\Commenting\ParamReturnAndVarTagMalformsFixer\ParamReturnAndVarTagMalformsFixerTest
3128
*/
32-
final class ParamReturnAndVarTagMalformsFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
29+
final class ParamReturnAndVarTagMalformsFixer extends AbstractSymplifyFixer
3330
{
3431
/**
3532
* @var string
@@ -142,29 +139,4 @@ public function getPriority(): int
142139
{
143140
return -37;
144141
}
145-
146-
public function getRuleDefinition(): RuleDefinition
147-
{
148-
return new RuleDefinition(self::ERROR_MESSAGE, [
149-
new CodeSample(
150-
<<<'CODE_SAMPLE'
151-
/**
152-
* @param string
153-
*/
154-
function getPerson($name)
155-
{
156-
}
157-
CODE_SAMPLE
158-
,
159-
<<<'CODE_SAMPLE'
160-
/**
161-
* @param string $name
162-
*/
163-
function getPerson($name)
164-
{
165-
}
166-
CODE_SAMPLE
167-
),
168-
]);
169-
}
170142
}

‎src/Fixer/Commenting/RemoveUselessDefaultCommentFixer.php‎

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,11 @@
1313
use Symplify\CodingStandard\Fixer\AbstractSymplifyFixer;
1414
use Symplify\CodingStandard\Fixer\Naming\ClassNameResolver;
1515
use Symplify\CodingStandard\TokenRunner\Traverser\TokenReverser;
16-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
17-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
18-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
1916

2017
/**
2118
* @see \Symplify\CodingStandard\Tests\Fixer\Commenting\RemoveUselessDefaultCommentFixer\RemoveUselessDefaultCommentFixerTest
2219
*/
23-
final class RemoveUselessDefaultCommentFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
20+
final class RemoveUselessDefaultCommentFixer extends AbstractSymplifyFixer
2421
{
2522
/**
2623
* @var string
@@ -79,37 +76,4 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
7976
}
8077
}
8178
}
82-
83-
public function getRuleDefinition(): RuleDefinition
84-
{
85-
return new RuleDefinition(self::ERROR_MESSAGE, [
86-
new CodeSample(
87-
<<<'CODE_SAMPLE'
88-
/**
89-
* class SomeClass
90-
*/
91-
class SomeClass
92-
{
93-
/**
94-
* SomeClass Constructor.
95-
*/
96-
public function __construct()
97-
{
98-
// TODO: Change the autogenerated stub
99-
// TODO: Implement whatever() method.
100-
}
101-
}
102-
CODE_SAMPLE
103-
,
104-
<<<'CODE_SAMPLE'
105-
class SomeClass
106-
{
107-
public function __construct()
108-
{
109-
}
110-
}
111-
CODE_SAMPLE
112-
),
113-
]);
114-
}
11579
}

‎src/Fixer/LineLength/LineLengthFixer.php‎

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,12 @@
2222
use Symplify\CodingStandard\TokenRunner\Transformer\FixerTransformer\LineLengthTransformer;
2323
use Symplify\CodingStandard\TokenRunner\ValueObject\BlockInfo;
2424
use Symplify\RuleDocGenerator\Contract\ConfigurableRuleInterface;
25-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
26-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
27-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
2825

2926
/**
3027
* @see \Symplify\CodingStandard\Tests\Fixer\LineLength\LineLengthFixer\LineLengthFixerTest
3128
* @see \Symplify\CodingStandard\Tests\Fixer\LineLength\LineLengthFixer\ConfiguredLineLengthFixerTest
3229
*/
33-
final class LineLengthFixer extends AbstractSymplifyFixer implements ConfigurableRuleInterface, ConfigurableFixerInterface, DocumentedRuleInterface
30+
final class LineLengthFixer extends AbstractSymplifyFixer implements ConfigurableRuleInterface, ConfigurableFixerInterface
3431
{
3532
/**
3633
* @api
@@ -138,41 +135,6 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
138135
}
139136
}
140137

141-
public function getRuleDefinition(): RuleDefinition
142-
{
143-
return new RuleDefinition(self::ERROR_MESSAGE, [
144-
new ConfiguredCodeSample(
145-
<<<'CODE_SAMPLE'
146-
function some($veryLong, $superLong, $oneMoreTime)
147-
{
148-
}
149-
150-
function another(
151-
$short,
152-
$now
153-
) {
154-
}
155-
CODE_SAMPLE
156-
,
157-
<<<'CODE_SAMPLE'
158-
function some(
159-
$veryLong,
160-
$superLong,
161-
$oneMoreTime
162-
) {
163-
}
164-
165-
function another($short, $now) {
166-
}
167-
CODE_SAMPLE
168-
,
169-
[
170-
self::LINE_LENGTH => 40,
171-
]
172-
),
173-
]);
174-
}
175-
176138
/**
177139
* Must run before
178140
*

‎src/Fixer/Spacing/MethodChainingNewlineFixer.php‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,11 @@
1414
use Symplify\CodingStandard\TokenAnalyzer\ChainMethodCallAnalyzer;
1515
use Symplify\CodingStandard\TokenRunner\Analyzer\FixerAnalyzer\BlockFinder;
1616
use Symplify\CodingStandard\TokenRunner\ValueObject\BlockInfo;
17-
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
18-
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
19-
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
2017

2118
/**
2219
* @see \Symplify\CodingStandard\Tests\Fixer\Spacing\MethodChainingNewlineFixer\MethodChainingNewlineFixerTest
2320
*/
24-
final class MethodChainingNewlineFixer extends AbstractSymplifyFixer implements DocumentedRuleInterface
21+
final class MethodChainingNewlineFixer extends AbstractSymplifyFixer
2522
{
2623
/**
2724
* @var string
@@ -79,22 +76,6 @@ public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
7976
}
8077
}
8178

82-
public function getRuleDefinition(): RuleDefinition
83-
{
84-
return new RuleDefinition(self::ERROR_MESSAGE, [
85-
new CodeSample(
86-
<<<'CODE_SAMPLE'
87-
$someClass->firstCall()->secondCall();
88-
CODE_SAMPLE
89-
,
90-
<<<'CODE_SAMPLE'
91-
$someClass->firstCall()
92-
->secondCall();
93-
CODE_SAMPLE
94-
),
95-
]);
96-
}
97-
9879
/**
9980
* @param Tokens<Token> $tokens
10081
*/

0 commit comments

Comments
 (0)