Merge pull request #20 from nanasess/add-development-libraries

feat: add comprehensive development tools and improve code quality

Author: nanasess

.editorconfig

@@ -12,4 +12,7 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.md]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = false
+
+[{*.neon,phpstan.neon.dist}]
+indent_style = tab

.github/workflows/ci.yml

@@ -2,11 +2,41 @@ name: CI
 on: [push, pull_request]
 
 permissions:
-  contents: read #  to fetch code (actions/checkout)
+    contents: read #  to fetch code (actions/checkout)
 
 jobs:
+    php-cs-fixer:
+        name: PHP-CS-Fixer
+        runs-on: ubuntu-latest
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v4
+            -   name: Install dependencies
+                uses: php-actions/composer@v6
+                with:
+                    php_version: '8.1'
+            -   name: Run PHP-CS-Fixer
+                run: vendor/bin/php-cs-fixer fix --dry-run --diff --allow-risky=yes
+
+    phpstan:
+        name: PHPStan
+        needs: php-cs-fixer
+        runs-on: ubuntu-latest
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v4
+            -   name: Install dependencies
+                uses: php-actions/composer@v6
+                with:
+                    php_version: '8.1'
+            -   name: Run PHPStan
+                uses: php-actions/phpstan@v3
+                with:
+                    php_version: '8.1'
+
     tests:
         name: Tests
+        needs: phpstan
         timeout-minutes: 10
         runs-on: ${{ matrix.os }}
         steps:

.github/workflows/rector.yaml

@@ -0,0 +1,36 @@
+# github action that checks code with Rector
+name: Rector
+
+on:
+    pull_request: null
+
+jobs:
+    rector:
+        runs-on: ubuntu-latest
+        if: github.event.pull_request.head.repo.full_name == 'nanasess/bcmath-polyfill'
+        steps:
+            -
+                if: github.event.pull_request.head.repo.full_name == github.repository
+                uses: actions/checkout@v4
+                with:
+                    # Must be used to trigger workflow after push
+                    token: ${{ secrets.ACCESS_TOKEN }}
+
+            -
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: 8.1
+                    coverage: none
+
+            -   uses: "ramsey/composer-install@v3"
+
+            -   run: vendor/bin/rector --ansi
+            # @todo apply coding standard if used
+
+            -
+                # commit only to core contributors who have repository access
+                uses: stefanzweifel/git-auto-commit-action@v5
+                with:
+                    commit_message: '[rector] Rector fixes'
+                    commit_author: 'GitHub Action <[email protected]>'
+                    commit_user_email: '[email protected]'

.php-cs-fixer.dist.php

@@ -0,0 +1,31 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+              ->in(__DIR__.'/src')
+              ->in(__DIR__.'/lib')
+              ->in(__DIR__.'/tests')
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PER-CS' => true,
+        '@PHP81Migration' => true,
+        '@PHPUnit100Migration:risky' => true,
+        '@PhpCsFixer' => true,
+        'fully_qualified_strict_types' => false,
+        'yoda_style' => false,
+        'php_unit_data_provider_method_order' => false,
+        'phpdoc_align' => false,
+        'ordered_class_elements' => false,
+        'increment_style' => false,
+        '@PhpCsFixer:risky' => true,
+        'strict_comparison' => false,
+        'is_null' => false,
+        'native_function_invocation' => false,
+        'error_suppression' => true,
+        'php_unit_test_case_static_method_calls' => false,
+        'final_internal_class' => false,
+        'php_unit_data_provider_name' => false,
+    ])
+    ->setFinder($finder)
+;

composer.json

@@ -33,7 +33,9 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^10.5",
-        "squizlabs/php_codesniffer": "^3.0"
+        "phpstan/phpstan": "^2.1",
+        "friendsofphp/php-cs-fixer": "^3.86",
+        "rector/rector": "^2.1"
     },
     "suggest": {
         "ext-gmp": "Will enable faster math operations"