main | stricter typing and linting & workflow

Author: chr15k

.github/workflows/main.yml

@@ -0,0 +1,36 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run test suite
+      run: composer test

composer.json

@@ -56,7 +56,12 @@
         }
     },
     "scripts": {
-        "refacto": "rector",
+        "refactor": "rector",
+        "tidy": [
+            "@lint",
+            "@refactor",
+            "@lint"
+        ],
         "lint": "pint",
         "test:refacto": "rector --dry-run",
         "test:lint": "pint --test",

config/response-compression.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
 
     /**

pint.json

@@ -0,0 +1,45 @@
+{
+    "preset": "laravel",
+    "rules": {
+        "array_push": true,
+        "backtick_to_shell_exec": true,
+        "declare_strict_types": true,
+        "final_class": true,
+        "fully_qualified_strict_types": true,
+        "global_namespace_import": {
+            "import_classes": true,
+            "import_constants": true,
+            "import_functions": true
+        },
+        "ordered_class_elements": {
+            "order": [
+                "use_trait",
+                "case",
+                "constant",
+                "constant_public",
+                "constant_protected",
+                "constant_private",
+                "property_public",
+                "property_protected",
+                "property_private",
+                "construct",
+                "destruct",
+                "magic",
+                "phpunit",
+                "method_abstract",
+                "method_public_static",
+                "method_public",
+                "method_protected_static",
+                "method_protected",
+                "method_private_static",
+                "method_private"
+            ],
+            "sort_algorithm": "none"
+        },
+        "ordered_interfaces": true,
+        "ordered_traits": true,
+        "protected_to_private": true,
+        "strict_comparison": true
+    },
+    "notPath": ["tests/TestCase.php"]
+}

rector.php

@@ -3,16 +3,12 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
 
 return RectorConfig::configure()
     ->withPaths([
         __DIR__.'/src',
         __DIR__.'/tests',
     ])
-    ->withSkip([
-        AddOverrideAttributeToOverriddenMethodsRector::class,
-    ])
     ->withPreparedSets(
         deadCode: true,
         codeQuality: true,

src/Contracts/Encoder.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Chr15k\ResponseCompression\Contracts;
 
 use Symfony\Component\HttpFoundation\Response;

src/Encoders/BrotliEncoder.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Chr15k\ResponseCompression\Encoders;
 
 use Chr15k\ResponseCompression\Contracts\Encoder;

src/Encoders/GzipEncoder.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Chr15k\ResponseCompression\Encoders;
 
 use Chr15k\ResponseCompression\Contracts\Encoder;

src/Middleware/CompressResponse.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Chr15k\ResponseCompression\Middleware;
 
 use Chr15k\ResponseCompression\Encoders\BrotliEncoder;

src/ResponseCompressionServiceProvider.php

@@ -1,29 +1,31 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Chr15k\ResponseCompression;
 
 use Illuminate\Support\ServiceProvider;
 
-class ResponseCompressionServiceProvider extends ServiceProvider
+final class ResponseCompressionServiceProvider extends ServiceProvider
 {
     public static string $abstract = 'response-compression';
 
     public function getConfigPath(): string
     {
-        return sprintf('%s/../config/%s.php', __DIR__, static::$abstract);
+        return sprintf('%s/../config/%s.php', __DIR__, self::$abstract);
     }
 
     public function register(): void
     {
-        $this->mergeConfigFrom($this->getConfigPath(), static::$abstract);
+        $this->mergeConfigFrom($this->getConfigPath(), self::$abstract);
     }
 
     public function boot(): void
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                $this->getConfigPath() => config_path(static::$abstract.'.php'),
-            ], static::$abstract.'-config');
+                $this->getConfigPath() => config_path(self::$abstract.'.php'),
+            ], self::$abstract.'-config');
         }
     }
 }