Replace StyleCI with PHP CS Fixer (#294)

Author: mspirkov

.github/workflows/rector-cs.yml

@@ -0,0 +1,27 @@
+name: Rector + PHP CS Fixer
+
+on:
+  pull_request_target:
+    paths:
+      - 'src/**'
+      - 'tests/**'
+      - '.github/workflows/rector-cs.yml'
+      - 'composer.json'
+      - 'rector.php'
+      - '.php-cs-fixer.dist.php'
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  rector:
+    uses: yiisoft/actions/.github/workflows/rector-cs.yml@master
+    secrets:
+      token: ${{ secrets.YIISOFT_GITHUB_TOKEN }}
+    with:
+      repository: ${{ github.event.pull_request.head.repo.full_name }}
+      php: '8.1'

.github/workflows/rector.yml

@@ -36,3 +36,7 @@ phpunit.phar
 /node_modules
 /package-lock.json
 .phpunit.result.cache
+
+# PHP CS Fixer
+/.php-cs-fixer.cache
+/.php-cs-fixer.php

.gitignore

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+$finder = (new Finder())->in([
+    __DIR__ . '/src',
+    __DIR__ . '/tests',
+]);
+
+return (new Config())
+    ->setRiskyAllowed(true)
+    ->setParallelConfig(ParallelConfigFactory::detect())
+    ->setRules([
+        '@PER-CS3.0' => true,
+        'no_unused_imports' => true,
+        'ordered_class_elements' => true,
+        'class_attributes_separation' => ['elements' => ['method' => 'one']],
+        'declare_strict_types' => true,
+        'native_function_invocation' => true,
+        'native_constant_invocation' => true,
+        'fully_qualified_strict_types' => [
+            'import_symbols' => true
+        ],
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+    ])
+    ->setFinder($finder);

.php-cs-fixer.dist.php

@@ -5,6 +5,7 @@
 - Enh #287: Allow `Dropdown::togglerVariant()` to be `null`, avoiding it setting a variant class (@Mister-42)
 - Bug #288: Add support for custom togglerClasses in `Dropdown` widget, and `addDropdownClass()` method (@terabytesoftw)
 - Enh #291: Add `navId()` method to `NavBar` widget (@terabytesoftw)
+- Enh #294: Explicitly import classes and functions in "use" section (@mspirkov)
 
 ## 1.0.0 April 13, 2025
 

.styleci.yml

@@ -21,6 +21,7 @@
         "yiisoft/widget": "^2.0"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.92.5",
         "maglnet/composer-require-checker": "^4.1",
         "phpunit/phpunit": "^10.5",
         "rector/rector": "^2.0",

CHANGELOG.md

@@ -67,7 +67,7 @@ final class Accordion extends Widget
 
     private array $togglerAttributes = [];
 
-    private string|null $togglerTag = null;
+    private ?string $togglerTag = null;
 
     /**
      * Adds a sets of attributes.

composer.json

@@ -37,8 +37,7 @@ private function __construct(
         private bool $encodeHeader,
         private string $header,
         private bool|string $id,
-    ) {
-    }
+    ) {}
 
     /**
      * Creates a new {@see AccordionItem} instance.
@@ -59,7 +58,7 @@ public static function to(
         bool|string $id = true,
         bool $encodeHeader = true,
         bool $encodeBody = true,
-        bool $active = false
+        bool $active = false,
     ): self {
         return new self($active, $body, $encodeBody, $encodeHeader, $header, $id);
     }

src/Accordion.php

@@ -43,15 +43,15 @@ final class Alert extends Widget
 
     private array $closeButtonAttributes = [];
 
-    private string|null $closeButtonTag = null;
+    private ?string $closeButtonTag = null;
 
     private string $closeButtonLabel = '';
 
     private bool $dismissable = false;
 
     private bool $fade = false;
 
-    private string|null $header = null;
+    private ?string $header = null;
 
     private array $headerAttributes = [];
 
@@ -417,7 +417,7 @@ public function fade(bool $enabled): self
      * $alert->header('Header content');
      * ```
      */
-    public function header(string|null $content, bool $encode = true): self
+    public function header(?string $content, bool $encode = true): self
     {
         if ($encode) {
             $content = Html::encode($content);
@@ -562,7 +562,7 @@ public function render(): string
                 '{header}' => $this->renderHeader(),
                 '{body}' => $this->body,
                 '{toggler}' => $toggler,
-            ]
+            ],
         );
 
         $content = preg_replace("/\n{2}/", "\n", $content) ?? '';
@@ -577,7 +577,7 @@ public function render(): string
      *
      * @psalm-return non-empty-string|null The generated ID.
      */
-    private function getId(): string|null
+    private function getId(): ?string
     {
         return match ($this->id) {
             true => $this->attributes['id'] ?? Html::generateId(self::NAME . '-'),