Check the code style fully on CI

Author: mspirkov

.gitattributes

@@ -28,6 +28,7 @@
 /.git-blame-ignore-revs     export-ignore
 /.gitattributes             export-ignore
 /.gitignore                 export-ignore
+/.php-cs-fixer.dist.php     export-ignore
 /phpcs.xml.dist             export-ignore
 /phpstan-baseline.neon      export-ignore
 /phpstan.dist.neon          export-ignore

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,31 @@
+name: php-cs-fixer
+
+permissions:
+  contents: read
+
+on:
+  pull_request: &ignore-paths
+    paths-ignore:
+      - ".github/CONTRIBUTING.md"
+      - ".github/FUNDING.yml"
+      - ".github/ISSUE_TEMPLATE.md"
+      - ".github/PULL_REQUEST_TEMPLATE.md"
+      - ".github/SECURITY.md"
+      - ".editorconfig"
+      - ".git-blame-ignore-revs"
+      - ".gitattributes"
+      - ".gitignore"
+      - "LICENSE.md"
+      - "README.md"
+      - "CHANGELOG.md"
+      - "UPGRADE.md"
+
+  push: *ignore-paths
+
+jobs:
+  php-cs-fixer:
+    uses: yiisoft/yii2-actions/.github/workflows/php-cs-fixer.yml@9bfbe47bd91bc31a6ff9f0ea77ba3724d7816c3d # master
+    with:
+      composer-root-version: 2.0.x-dev
+      configuration: .php-cs-fixer.dist.php
+      php-version: '["7.4"]'

.github/workflows/linter.yml .github/workflows/phpcs.yml.github/workflows/linter.yml renamed to .github/workflows/phpcs.yml

@@ -1,4 +1,4 @@
-name: linter
+name: phpcs
 
 permissions:
   contents: read

.gitignore

@@ -46,3 +46,7 @@ phpstan.neon
 
 # local phpcs config
 phpcs.xml
+
+# PHP CS Fixer
+.php-cs-fixer.php
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,35 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$header = '@link https://www.yiiframework.com/
+@copyright Copyright (c) 2008 Yii Software LLC
+@license https://www.yiiframework.com/license/';
+
+$finder = (new Finder())
+    ->in([
+        __DIR__ . '/commands',
+        __DIR__ . '/components',
+        __DIR__ . '/helpers',
+        __DIR__ . '/models',
+        __DIR__ . '/renderers',
+        __DIR__ . '/templates',
+        __DIR__ . '/tests',
+    ])
+    ->notPath([
+        '#(^|/)data/#',
+        '#(^|/)layouts/#',
+        '#(^|/)views/#',
+    ]);
+
+return (new Config())
+    ->setFinder($finder)
+    ->setRules([
+        'phpdoc_scalar' => true,
+        'header_comment' => [
+            'comment_type' => 'PHPDoc',
+            'header' => $header,
+            'location' => 'after_open',
+        ],
+    ]);

composer.json

@@ -38,7 +38,9 @@
         "phpstan/phpstan": "^2.1",
         "yiisoft/yii2-coding-standards": "^3.0",
         "rector/rector": "^2.3",
-        "mspirkov/yii2-rector": "^0.1"
+        "mspirkov/yii2-rector": "^0.1",
+        "slevomat/coding-standard": "^8.31",
+        "friendsofphp/php-cs-fixer": "^3.95"
     },
     "repositories": [
         {
@@ -64,12 +66,13 @@
     "bin": ["apidoc"],
     "config": {
         "allow-plugins": {
-            "yiisoft/yii2-composer": true
+            "yiisoft/yii2-composer": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
         }
     },
     "scripts": {
-        "cs": "./vendor/bin/phpcs",
-        "cs-fix": "./vendor/bin/phpcbf",
+        "cs": "./vendor/bin/phpcs && ./vendor/bin/php-cs-fixer check",
+        "cs-fix": "./vendor/bin/phpcbf && ./vendor/bin/php-cs-fixer fix",
         "static": "./vendor/bin/phpstan --memory-limit=-1",
         "tests": "./vendor/bin/phpunit",
         "rector": "./vendor/bin/rector"

models/BaseDoc.php

@@ -43,6 +43,7 @@ class BaseDoc extends BaseObject
     private const PSALM_IMPORT_TYPE_ANNOTATION_NAME = 'psalm-import-type';
     public const INHERITDOC_TAG_NAME = 'inheritdoc';
     private const TODO_TAG_NAME = 'todo';
+
     /**
      * @var \phpDocumentor\Reflection\Types\Context|null
      */
@@ -103,8 +104,6 @@ class BaseDoc extends BaseObject
      * @var array<string, Template>
      */
     public $templates = [];
-
-
     /**
      * @var array<string, PseudoTypeDoc>
      */
@@ -121,6 +120,8 @@ class BaseDoc extends BaseObject
      * @var array<string, PseudoTypeImportDoc>
      */
     public array $psalmTypeImports = [];
+
+
     /**
      * Checks if doc has tag of a given name
      * @param string $name tag name

phpcs.xml.dist

@@ -2,6 +2,29 @@
 <ruleset name="Yii2">
     <rule ref="vendor/yiisoft/yii2-coding-standards/Yii2"></rule>
 
+    <rule ref="SlevomatCodingStandard.Classes.TraitUseSpacing">
+        <properties>
+            <property name="linesCountBeforeFirstUseWhenFirstInClass" value="0"/>
+            <property name="linesCountAfterLastUseWhenLastInClass" value="0"/>
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Classes.ConstantSpacing">
+        <properties>
+            <property name="minLinesCountBeforeWithComment" value="0"/>
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Classes.PropertySpacing">
+        <properties>
+            <property name="minLinesCountBeforeWithComment" value="0"/>
+        </properties>
+    </rule>
+    <rule ref="SlevomatCodingStandard.Classes.MethodSpacing">
+        <properties>
+            <property name="minLinesCount" value="1"/>
+            <property name="maxLinesCount" value="2"/>
+        </properties>
+    </rule>
+
     <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
         <exclude-pattern>tests/bootstrap.php</exclude-pattern>
     </rule>

tests/TestCase.php

@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * @link https://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license https://www.yiiframework.com/license/
+ */
+
 namespace yiiunit\apidoc;
 
 use Exception;

tests/bootstrap.php

@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * @link https://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license https://www.yiiframework.com/license/
+ */
+
 // ensure we get report on all possible php errors
 error_reporting(-1);