Update coding standards

ci/php-cs-fixer.php

@@ -1,60 +1,31 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 $finder = PhpCsFixer\Finder::create()
-    ->in([dirname(__DIR__) . '/src', dirname(__DIR__) . '/tests'])
-    ->exclude('unit/fixtures');
+    ->in([dirname(__DIR__) . '/src', dirname(__DIR__) . '/tests']);
 
 $rules = [
-    '@PSR12'                      => true,
-    '@PHP71Migration'             => true,
-    '@PHP71Migration:risky'       => true,
-    '@PHP73Migration'             => true,
-    '@PHP74Migration'             => true,
-    '@PHP74Migration:risky'       => true,
-    '@PHP80Migration'             => true,
+    '@PER'                        => true,
     '@PHP80Migration:risky'       => true,
-    '@PHP81Migration'             => true,
-    'array_syntax'                => ['syntax' => 'short'],
-    'binary_operator_spaces'      => ['default' => 'align_single_space_minimal'],
-    'align_multiline_comment'     => ['comment_type' => 'phpdocs_like'],
-    'combine_consecutive_issets'  => true,
-    'combine_consecutive_unsets'  => true,
-    'compact_nullable_typehint'   => true,
-    'escape_implicit_backslashes' => true,
-    'explicit_indirect_variable'  => true,
-    'explicit_string_variable'    => true,
-    'final_internal_class'        => true,
-    'linebreak_after_opening_tag' => true,
-    'list_syntax'                 => ['syntax' => 'short'],
+    '@PHP82Migration'             => true,
+    '@PhpCsFixer'                 => true,
+    PhpCsFixerCustomFixers\Fixer\DeclareAfterOpeningTagFixer::name() => true,
+    PhpCsFixerCustomFixers\Fixer\PhpdocArrayStyleFixer::name() => true,
+    PhpCsFixerCustomFixers\Fixer\ConstructorEmptyBracesFixer::name() => true,
+    'phpdoc_line_span'            => ['property' => 'single', 'const' => 'single'],
+    'phpdoc_separation'           => ['groups' => [['deprecated', 'link', 'see', 'since'], ['template', 'template-covariant'], ['param', 'return', 'throws']], 'skip_unlisted_annotations' => true],
     'mb_str_functions'            => true,
-    'method_argument_space' => [
-        'keep_multiple_spaces_after_comma' => false,
-        'on_multiline'                     => 'ensure_fully_multiline',
-        'after_heredoc'                    => true,
-    ],
-    'method_chaining_indentation' => true,
-    'no_php4_constructor'         => true,
-    'no_superfluous_elseif'       => true,
-    'no_useless_else'             => true,
-    'no_useless_return'           => true,
-    'ordered_class_elements'      => true,
-    'no_unused_imports'           => true,
-    'ordered_imports'             => true,
+    'compact_nullable_typehint'   => true,
     'single_line_after_imports'   => true,
-    'global_namespace_import'     => false,
-    'php_unit_strict'             => true,
-    'phpdoc_order'                => true,
-    'phpdoc_types_order'          => true,
-    'simplified_null_return'      => true,
     'strict_comparison'           => true,
     'strict_param'                => true,
+    'blank_line_before_statement' => ['statements' => ['continue', 'declare', 'exit', 'include', 'include_once', 'phpdoc', 'require', 'require_once', 'return', 'switch', 'throw', 'try', 'yield', 'yield_from']],
+    'yoda_style'                  =>  ['equal' => false, 'identical' => false, 'less_and_greater' => false],
     //enable when min php >= 8.0
     'get_class_to_class_keyword'  => false,
 ];
 
 return (new PhpCsFixer\Config())
+    ->registerCustomFixers(new PhpCsFixerCustomFixers\Fixers())
     ->setFinder($finder)
     ->setRules($rules)
     ->setRiskyAllowed(true);

composer.json

@@ -15,6 +15,7 @@
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.0",
+    "kubawerlos/php-cs-fixer-custom-fixers": "^3.16",
     "phpunit/phpunit": "^9.0",
     "vimeo/psalm": "^4.0 || ^5.0"
   },

src/Configuration.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat;
 
@@ -15,9 +13,9 @@ public function __construct(
         bool $ignore_built_in_classes,
         bool $show_rule_names
     ) {
-        $this->ignore_doc_comments     = $ignore_doc_comments;
+        $this->ignore_doc_comments = $ignore_doc_comments;
         $this->ignore_built_in_classes = $ignore_built_in_classes;
-        $this->show_rule_names         = $show_rule_names;
+        $this->show_rule_names = $show_rule_names;
     }
 
     public function ignoreDocComments(): bool

src/Parser/TypeNodeParser.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Parser;
 
@@ -45,7 +43,6 @@ private static function parseComplex(ComplexType $type, Scope $scope): array
     }
 
     /**
-     * @param NodeAbstract $type
      * @return array<Identifier|Name>
      */
     private static function flattenType(NodeAbstract $type): array

src/Rule/Assertion/Assertion.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion;
 

src/Rule/Assertion/Declaration/Declaration.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration;
 

src/Rule/Assertion/Declaration/DeclarationAssertion.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration;
 
@@ -18,7 +16,7 @@
 
 abstract class DeclarationAssertion implements Assertion
 {
-    /** @var array<array{string, SelectorInterface, array<SelectorInterface>, string[]}> */
+    /** @var array<array{string, SelectorInterface, array<SelectorInterface>, array<string>}> */
     protected array $statements;
     protected Configuration $configuration;
     protected ReflectionProvider $reflectionProvider;
@@ -34,10 +32,10 @@ public function __construct(
         ReflectionProvider $reflectionProvider,
         FileTypeMapper $fileTypeMapper
     ) {
-        $this->statements         = $statementBuilderFactory->create($assertion)->build();
-        $this->configuration      = $configuration;
+        $this->statements = $statementBuilderFactory->create($assertion)->build();
+        $this->configuration = $configuration;
         $this->reflectionProvider = $reflectionProvider;
-        $this->fileTypeMapper     = $fileTypeMapper;
+        $this->fileTypeMapper = $fileTypeMapper;
     }
 
     /**
@@ -64,33 +62,32 @@ public function prepareMessage(string $ruleName, string $message): string
     abstract protected function meetsDeclaration(Node $node, Scope $scope): bool;
 
     /**
-     * @param string $ruleName
      * @param class-string $subject
      */
     abstract protected function getMessage(string $ruleName, string $subject): string;
 
     /**
-     * @param string[] $tips
+     * @param  array<string>    $tips
      * @return array<RuleError>
      */
     abstract protected function applyValidation(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips): array;
 
     protected function ruleApplies(Scope $scope): bool
     {
-        if (!($scope->isInClass())) {
+        if (!$scope->isInClass()) {
             return false;
         }
 
         return $scope->getClassReflection() !== null;
     }
 
     /**
-     * @throws ShouldNotHappenException
      * @return array<RuleError>
+     * @throws ShouldNotHappenException
      */
     protected function validateGetErrors(Scope $scope, bool $meetsDeclaration): array
     {
-        $errors  = [];
+        $errors = [];
         $subject = $scope->getClassReflection();
         if ($subject === null) {
             throw new ShouldNotHappenException();

src/Rule/Assertion/Declaration/ShouldBeAbstract/AbstractRule.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldBeAbstract;
 

src/Rule/Assertion/Declaration/ShouldBeAbstract/ShouldBeAbstract.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldBeAbstract;
 

src/Rule/Assertion/Declaration/ShouldBeFinal/IsFinalRule.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldBeFinal;
 

src/Rule/Assertion/Declaration/ShouldBeFinal/ShouldBeFinal.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldBeFinal;
 
@@ -33,10 +31,7 @@ public function __construct(
     }
 
     /**
-     * @param string $ruleName
-     * @param ClassReflection $subject
-     * @param bool $meetsDeclaration
-     * @param string[] $tips
+     * @param  array<string>    $tips
      * @return array<RuleError>
      */
     protected function applyValidation(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips): array

src/Rule/Assertion/Declaration/ShouldBeReadonly/IsReadonlyRule.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldBeReadonly;
 

src/Rule/Assertion/Declaration/ShouldBeReadonly/ShouldBeReadonly.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldBeReadonly;
 
@@ -33,10 +31,7 @@ public function __construct(
     }
 
     /**
-     * @param string $ruleName
-     * @param ClassReflection $subject
-     * @param bool $meetsDeclaration
-     * @param string[] $tips
+     * @param  array<string>    $tips
      * @return array<RuleError>
      */
     protected function applyValidation(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips): array

src/Rule/Assertion/Declaration/ShouldNotBeAbstract/AbstractRule.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldNotBeAbstract;
 

src/Rule/Assertion/Declaration/ShouldNotBeAbstract/ShouldNotBeAbstract.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldNotBeAbstract;
 

src/Rule/Assertion/Declaration/ShouldNotBeFinal/IsFinalRule.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldNotBeFinal;
 

src/Rule/Assertion/Declaration/ShouldNotBeFinal/ShouldNotBeFinal.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration\ShouldNotBeFinal;
 

src/Rule/Assertion/Declaration/ValidationTrait.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Declaration;
 
@@ -13,9 +11,9 @@
 trait ValidationTrait
 {
     /**
-     * @param string[] $tips
-     * @throws ShouldNotHappenException
+     * @param  array<string>            $tips
      * @return array<RuleError>
+     * @throws ShouldNotHappenException
      */
     protected function applyShould(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips): array
     {
@@ -26,7 +24,7 @@ protected function applyShould(string $ruleName, ClassReflection $subject, bool
                 $this->getMessage($ruleName, $subject->getName())
             );
 
-            foreach($tips as $tip) {
+            foreach ($tips as $tip) {
                 $ruleError->addTip($tip);
             }
             $errors[] = $ruleError->build();
@@ -36,9 +34,9 @@ protected function applyShould(string $ruleName, ClassReflection $subject, bool
     }
 
     /**
-     * @param string[] $tips
-     * @throws ShouldNotHappenException
+     * @param  array<string>            $tips
      * @return array<RuleError>
+     * @throws ShouldNotHappenException
      */
     protected function applyShouldNot(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips): array
     {
@@ -49,7 +47,7 @@ protected function applyShouldNot(string $ruleName, ClassReflection $subject, bo
                 $this->getMessage($ruleName, $subject->getName())
             );
 
-            foreach($tips as $tip) {
+            foreach ($tips as $tip) {
                 $ruleError->addTip($tip);
             }
             $errors[] = $ruleError->build();
@@ -58,9 +56,8 @@ protected function applyShouldNot(string $ruleName, ClassReflection $subject, bo
         return $errors;
     }
 
-
     /**
-     * @param class-string $classname
+     * @param class-string             $classname
      * @param array<SelectorInterface> $targetExcludes
      */
     private function nodeMatchesTarget(string $classname, SelectorInterface $target, array $targetExcludes): bool

src/Rule/Assertion/Relation/CanOnlyDepend/CanOnlyDepend.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Relation\CanOnlyDepend;
 

src/Rule/Assertion/Relation/CanOnlyDepend/ClassAttributeRule.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Relation\CanOnlyDepend;
 

src/Rule/Assertion/Relation/CanOnlyDepend/ClassPropertyRule.php

@@ -1,6 +1,4 @@
-<?php
-
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace PHPat\Rule\Assertion\Relation\CanOnlyDepend;