Skip to content

Commit a3dbd6c

Browse files
ondrejmirtesondrejmirtes
committed
Updated coding standard
1 parent c46bef1 commit a3dbd6c

15 files changed

+119
-88
lines changed

‎composer.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@
66
"php": "~7.1"
77
},
88
"require-dev": {
9-
"consistence/coding-standard": "^2.0.0",
9+
"consistence/coding-standard": "^3.5",
1010
"jakub-onderka/php-parallel-lint": "^0.9.2",
1111
"phing/phing": "^2.16.0",
1212
"phpstan/phpstan": "^0.10",
1313
"phpunit/phpunit": "^6.3",
14-
"slevomat/coding-standard": "^3.3.0",
14+
"slevomat/coding-standard": "^4.7.2",
15+
"squizlabs/php_codesniffer": "^3.3.2",
1516
"symfony/process": "^3.4 || ^4.0"
1617
},
1718
"autoload": {

‎phpcs.xml‎

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
<?xml version="1.0"?>
22
<ruleset name="PHPStan PHPDoc Parser">
33
<rule ref="vendor/consistence/coding-standard/Consistence/ruleset.xml">
4-
<exclude name="Squiz.Functions.GlobalFunction.Found"/>
5-
<exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
6-
</rule>
7-
<rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/ruleset.xml">
8-
<exclude name="SlevomatCodingStandard.Classes.ClassConstantVisibility.MissingConstantVisibility"/>
9-
<exclude name="SlevomatCodingStandard.Files.TypeNameMatchesFileName"/>
4+
<exclude name="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration.InvalidFormat"/>
105
<exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameAfterKeyword"/>
11-
<exclude name="SlevomatCodingStandard.Namespaces.UseOnlyWhitelistedNamespaces"/>
6+
<exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation"/>
127
<exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly"/>
13-
<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification"/>
14-
<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification"/>
15-
<exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation.NonFullyQualifiedClassName"/>
16-
<exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalConstants"/>
17-
<exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalFunctions"/>
18-
<exclude name="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue"/>
8+
<exclude name="Consistence.Exceptions.ExceptionDeclaration"/>
9+
<exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/>
10+
<exclude name="Squiz.Commenting.FunctionComment.ParamNameNoMatch"/>
11+
<exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
1912
</rule>
2013
<rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses">
2114
<properties>
@@ -31,11 +24,40 @@
3124
<properties>
3225
<property name="usefulAnnotations" type="array" value="
3326
@dataProvider,
34-
@requires,
35-
@throws
27+
@requires
3628
"/>
37-
<property name="enableNullableTypeHints" type="false" />
38-
<property name="enableVoidTypeHint" type="false" />
29+
<property name="enableObjectTypeHint" value="false"/>
30+
</properties>
31+
<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableParameterTypeHintSpecification"/>
32+
<exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification"/>
33+
</rule>
34+
<rule ref="SlevomatCodingStandard.ControlStructures.AssignmentInCondition"/>
35+
<rule ref="SlevomatCodingStandard.ControlStructures.DisallowEqualOperators"/>
36+
<rule ref="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceOperator"/>
37+
<rule ref="SlevomatCodingStandard.ControlStructures.EarlyExit"/>
38+
<rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming"/>
39+
<rule ref="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
40+
<rule ref="SlevomatCodingStandard.ControlStructures.DisallowShortTernaryOperator"/>
41+
<rule ref="SlevomatCodingStandard.Files.TypeNameMatchesFileName">
42+
<properties>
43+
<property name="rootNamespaces" type="array" value="src=>PHPStan\PhpDocParser,tests/PHPStan=>PHPStan\PhpDocParser"/>
3944
</properties>
4045
</rule>
46+
<rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
47+
<rule ref="SlevomatCodingStandard.Functions.StaticClosure"/>
48+
<rule ref="SlevomatCodingStandard.Operators.RequireCombinedAssignmentOperator"/>
49+
<rule ref="SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition"/>
50+
<rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration"/>
51+
<rule ref="SlevomatCodingStandard.Classes.TraitUseSpacing"/>
52+
<rule ref="SlevomatCodingStandard.Variables.UnusedVariable"/>
53+
<rule ref="SlevomatCodingStandard.Variables.UselessVariable"/>
54+
<!--<rule ref="SlevomatCodingStandard.Functions.UnusedParameter"/>-->
55+
<rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure"/>
56+
<rule ref="SlevomatCodingStandard.Namespaces.UselessAlias"/>
57+
<rule ref="SlevomatCodingStandard.PHP.UselessSemicolon"/>
58+
<rule ref="SlevomatCodingStandard.PHP.UselessParentheses"/>
59+
<exclude-pattern>tests/*/data</exclude-pattern>
60+
<exclude-pattern>tests/*/traits</exclude-pattern>
61+
<exclude-pattern>tests/notAutoloaded</exclude-pattern>
62+
<exclude-pattern>src/Reflection/SignatureMap/functionMap.php</exclude-pattern>
4163
</ruleset>

‎src/Ast/ConstExpr/ConstExprArrayItemNode.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
class ConstExprArrayItemNode implements ConstExprNode
66
{
77

8-
/** @var null|ConstExprNode */
8+
/** @var ConstExprNode|null */
99
public $key;
1010

1111
/** @var ConstExprNode */
@@ -23,9 +23,9 @@ public function __toString(): string
2323
if ($this->key !== null) {
2424
return "{$this->key} => {$this->value}";
2525

26-
} else {
27-
return "{$this->value}";
2826
}
27+
28+
return "{$this->value}";
2929
}
3030

3131
}

‎src/Ast/ConstExpr/ConstFetchNode.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ public function __toString(): string
2323
if ($this->className === '') {
2424
return $this->name;
2525

26-
} else {
27-
return "{$this->className}::{$this->name}";
2826
}
27+
28+
return "{$this->className}::{$this->name}";
2929
}
3030

3131
}

‎src/Ast/PhpDoc/MethodTagValueNode.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class MethodTagValueNode implements PhpDocTagValueNode
1010
/** @var bool */
1111
public $isStatic;
1212

13-
/** @var null|TypeNode */
13+
/** @var TypeNode|null */
1414
public $returnType;
1515

1616
/** @var string */

‎src/Ast/PhpDoc/MethodTagValueParameterNode.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
class MethodTagValueParameterNode implements Node
1010
{
1111

12-
/** @var null|TypeNode */
12+
/** @var TypeNode|null */
1313
public $type;
1414

1515
/** @var bool */
@@ -21,7 +21,7 @@ class MethodTagValueParameterNode implements Node
2121
/** @var string */
2222
public $parameterName;
2323

24-
/** @var null|ConstExprNode */
24+
/** @var ConstExprNode|null */
2525
public $defaultValue;
2626

2727
public function __construct(?TypeNode $type, bool $isReference, bool $isVariadic, string $parameterName, ?ConstExprNode $defaultValue)

‎src/Ast/PhpDoc/PhpDocNode.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public function __construct(array $children)
2424
*/
2525
public function getTags(): array
2626
{
27-
return array_filter($this->children, function (PhpDocChildNode $child): bool {
27+
return array_filter($this->children, static function (PhpDocChildNode $child): bool {
2828
return $child instanceof PhpDocTagNode;
2929
});
3030
}
@@ -36,7 +36,7 @@ public function getTags(): array
3636
*/
3737
public function getTagsByName(string $tagName): array
3838
{
39-
return array_filter($this->getTags(), function (PhpDocTagNode $tag) use ($tagName): bool {
39+
return array_filter($this->getTags(), static function (PhpDocTagNode $tag) use ($tagName): bool {
4040
return $tag->name === $tagName;
4141
});
4242
}
@@ -48,7 +48,7 @@ public function getTagsByName(string $tagName): array
4848
public function getVarTagValues(): array
4949
{
5050
return array_column(
51-
array_filter($this->getTagsByName('@var'), function (PhpDocTagNode $tag): bool {
51+
array_filter($this->getTagsByName('@var'), static function (PhpDocTagNode $tag): bool {
5252
return $tag->value instanceof VarTagValueNode;
5353
}),
5454
'value'
@@ -62,7 +62,7 @@ public function getVarTagValues(): array
6262
public function getParamTagValues(): array
6363
{
6464
return array_column(
65-
array_filter($this->getTagsByName('@param'), function (PhpDocTagNode $tag): bool {
65+
array_filter($this->getTagsByName('@param'), static function (PhpDocTagNode $tag): bool {
6666
return $tag->value instanceof ParamTagValueNode;
6767
}),
6868
'value'
@@ -76,7 +76,7 @@ public function getParamTagValues(): array
7676
public function getReturnTagValues(): array
7777
{
7878
return array_column(
79-
array_filter($this->getTagsByName('@return'), function (PhpDocTagNode $tag): bool {
79+
array_filter($this->getTagsByName('@return'), static function (PhpDocTagNode $tag): bool {
8080
return $tag->value instanceof ReturnTagValueNode;
8181
}),
8282
'value'
@@ -90,7 +90,7 @@ public function getReturnTagValues(): array
9090
public function getThrowsTagValues(): array
9191
{
9292
return array_column(
93-
array_filter($this->getTagsByName('@throws'), function (PhpDocTagNode $tag): bool {
93+
array_filter($this->getTagsByName('@throws'), static function (PhpDocTagNode $tag): bool {
9494
return $tag->value instanceof ThrowsTagValueNode;
9595
}),
9696
'value'
@@ -104,7 +104,7 @@ public function getThrowsTagValues(): array
104104
public function getPropertyTagValues(): array
105105
{
106106
return array_column(
107-
array_filter($this->getTagsByName('@property'), function (PhpDocTagNode $tag): bool {
107+
array_filter($this->getTagsByName('@property'), static function (PhpDocTagNode $tag): bool {
108108
return $tag->value instanceof PropertyTagValueNode;
109109
}),
110110
'value'
@@ -118,7 +118,7 @@ public function getPropertyTagValues(): array
118118
public function getPropertyReadTagValues(): array
119119
{
120120
return array_column(
121-
array_filter($this->getTagsByName('@property-read'), function (PhpDocTagNode $tag): bool {
121+
array_filter($this->getTagsByName('@property-read'), static function (PhpDocTagNode $tag): bool {
122122
return $tag->value instanceof PropertyTagValueNode;
123123
}),
124124
'value'
@@ -132,7 +132,7 @@ public function getPropertyReadTagValues(): array
132132
public function getPropertyWriteTagValues(): array
133133
{
134134
return array_column(
135-
array_filter($this->getTagsByName('@property-write'), function (PhpDocTagNode $tag): bool {
135+
array_filter($this->getTagsByName('@property-write'), static function (PhpDocTagNode $tag): bool {
136136
return $tag->value instanceof PropertyTagValueNode;
137137
}),
138138
'value'
@@ -146,7 +146,7 @@ public function getPropertyWriteTagValues(): array
146146
public function getMethodTagValues(): array
147147
{
148148
return array_column(
149-
array_filter($this->getTagsByName('@method'), function (PhpDocTagNode $tag): bool {
149+
array_filter($this->getTagsByName('@method'), static function (PhpDocTagNode $tag): bool {
150150
return $tag->value instanceof MethodTagValueNode;
151151
}),
152152
'value'

‎src/Lexer/Lexer.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ class Lexer
7575
public const VALUE_OFFSET = 0;
7676
public const TYPE_OFFSET = 1;
7777

78-
/** @var null|string */
78+
/** @var string|null */
7979
private $regexp;
8080

81-
/** @var null|int[] */
81+
/** @var int[]|null */
8282
private $types;
8383

8484
public function tokenize(string $s): array
@@ -108,7 +108,7 @@ public function tokenize(string $s): array
108108
}
109109

110110

111-
private function initialize()
111+
private function initialize(): void
112112
{
113113
$patterns = [
114114
// '&' followed by TOKEN_VARIADIC, TOKEN_VARIABLE, TOKEN_EQUAL, TOKEN_EQUAL or TOKEN_CLOSE_PARENTHESES

‎src/Parser/ConstExprParser.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ public function parse(TokenIterator $tokens): Ast\ConstExpr\ConstExprNode
5151
$tokens->consumeTokenType(Lexer::TOKEN_IDENTIFIER);
5252
return new Ast\ConstExpr\ConstFetchNode($identifier, $classConstantName);
5353

54-
} else {
55-
return new Ast\ConstExpr\ConstFetchNode('', $identifier);
5654
}
5755

56+
return new Ast\ConstExpr\ConstFetchNode('', $identifier);
57+
5858
} elseif ($tokens->tryConsumeTokenType(Lexer::TOKEN_OPEN_SQUARE_BRACKET)) {
5959
return $this->parseArray($tokens, Lexer::TOKEN_CLOSE_SQUARE_BRACKET);
6060
}

‎src/Parser/PhpDocParser.php‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ private function parseChild(TokenIterator $tokens): Ast\PhpDoc\PhpDocChildNode
5252
if ($tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_TAG)) {
5353
return $this->parseTag($tokens);
5454

55-
} else {
56-
return $this->parseText($tokens);
5755
}
56+
57+
return $this->parseText($tokens);
5858
}
5959

6060

@@ -261,9 +261,11 @@ private function parseOptionalDescription(TokenIterator $tokens, bool $limitStar
261261
{
262262
if ($limitStartToken) {
263263
foreach (self::DISALLOWED_DESCRIPTION_START_TOKENS as $disallowedStartToken) {
264-
if ($tokens->isCurrentTokenType($disallowedStartToken)) {
265-
$tokens->consumeTokenType(Lexer::TOKEN_OTHER); // will throw exception
264+
if (!$tokens->isCurrentTokenType($disallowedStartToken)) {
265+
continue;
266266
}
267+
268+
$tokens->consumeTokenType(Lexer::TOKEN_OTHER); // will throw exception
267269
}
268270
}
269271

0 commit comments

Comments
 (0)