feature: setup mago foramtter / linter, removed cs-fixer rector

Author: norberttech

.github/workflows/job-static-analyze.yml

@@ -28,17 +28,8 @@ jobs:
 
       - name: "Create cache directories"
         run: |
-          mkdir -p var/cs-fixer
           mkdir -p var/phpstan/cache
 
-      - name: "Cache cs-fixer results"
-        uses: "actions/cache@v5"
-        with:
-          path: "var/cs-fixer"
-          key: "php-${{ matrix.php-version }}-cache-cs-fixer-${{ github.run_id }}"
-          restore-keys: |
-            php-${{ matrix.php-version }}-cache-cs-fixer-
-
       - name: "Cache phpstan results"
         uses: "actions/cache@v5"
         with:
@@ -50,11 +41,8 @@ jobs:
       - name: "Monorepo Validate"
         run: "composer test:monorepo"
 
-      - name: "Static Analyze - CS Fixer"
-        run: "composer static:analyze:cs-fixer"
+      - name: "Static Analyze - Mago"
+        run: "composer static:analyze:mago"
 
       - name: "Static Analyze - PHPStan"
-        run: "composer static:analyze:phpstan -- --error-format=github"
-
-      - name: "Static Analyze - Rector"
-        run: "composer static:analyze:rector"
+        run: "composer static:analyze:phpstan -- --error-format=github"

.php-cs-fixer.php

@@ -339,24 +339,19 @@
         "test:monorepo": "tools/monorepo/vendor/bin/monorepo-builder validate",
         "static:analyze": [
             "./tools/monorepo/vendor/bin/monorepo-builder validate",
-            "@static:analyze:cs-fixer",
-            "@static:analyze:phpstan",
-            "@static:analyze:rector"
+            "@static:analyze:mago",
+            "@static:analyze:phpstan"
         ],
         "static:analyze:phpstan": [
             "tools/phpstan/vendor/bin/phpstan analyze -c phpstan.neon --memory-limit=-1"
         ],
-        "static:analyze:rector": [
-            "tools/rector/vendor/bin/rector -c ./rector.tests.php --dry-run",
-            "tools/rector/vendor/bin/rector -c ./rector.src.php --dry-run"
-        ],
-        "static:analyze:cs-fixer": [
-            "tools/cs-fixer/vendor/bin/php-cs-fixer fix --dry-run"
+        "static:analyze:mago": [
+            "tools/mago/vendor/bin/mago format --check",
+            "tools/mago/vendor/bin/mago lint"
         ],
         "cs:php:fix": [
-            "tools/cs-fixer/vendor/bin/php-cs-fixer fix",
-            "./tools/rector/vendor/bin/rector -c ./rector.src.php",
-            "./tools/rector/vendor/bin/rector -c ./rector.tests.php"
+            "tools/mago/vendor/bin/mago format",
+            "tools/mago/vendor/bin/mago lint --fix"
         ],
         "build:phar": [
             "bin/build-phar.sh",
@@ -448,23 +443,21 @@
         "tools:install": [
             "composer install --working-dir=./tools/blackfire",
             "composer install --working-dir=./tools/box",
-            "composer install --working-dir=./tools/cs-fixer",
             "composer install --working-dir=./tools/infection",
+            "composer install --working-dir=./tools/mago",
             "composer install --working-dir=./tools/monorepo",
             "composer install --working-dir=./tools/phpstan",
             "composer install --working-dir=./tools/phpunit",
-            "composer install --working-dir=./tools/rector",
             "composer install --working-dir=./tools/phpdocumentor"
         ],
         "tools:update": [
             "composer update --working-dir=./tools/blackfire",
             "composer update --working-dir=./tools/box",
-            "composer update --working-dir=./tools/cs-fixer",
             "composer update --working-dir=./tools/infection",
+            "composer update --working-dir=./tools/mago",
             "composer update --working-dir=./tools/monorepo",
             "composer update --working-dir=./tools/phpstan",
             "composer update --working-dir=./tools/phpunit",
-            "composer update --working-dir=./tools/rector",
             "composer update --working-dir=./tools/phpdocumentor"
         ]
     }

composer.json

@@ -59,8 +59,7 @@ If you want to first check what needs to be fixed, you can use:
 
 
 ```shell
-composer static:analyze:cs-fixer
-composer static:analyze:rector
+composer static:analyze:mago
 ```
 
 ## Test everything

documentation/contributing/environment.md

@@ -119,7 +119,7 @@ There are several tools used in this project to help with development, testing,
 Most of them are available as Composer scripts, so you can run them using `composer <script-name>`.
 
 - `composer static:analyze` runs static analysis tools like PHPStan to check the code for errors and potential issues.
-- `composer cs:php:fix` runs the PHP CS Fixer and Rector to automatically fix coding standards issues in the code.
+- `composer cs:php:fix` runs Mago to automatically fix coding standards and lint issues in the code.
     - `composer test` runs all tests in the project, including unit tests, functional tests, and integration tests. It's
       a combination of all other test commands:
     - `composer test:core`
@@ -137,7 +137,7 @@ Most of them are available as Composer scripts, so you can run them using `compo
 # Coding Standards
 
 The whole project is developed as an object oriented code, with a focus on clean code principles.
-The coding standards are defined and automatically enforced by the PHP CS Fixer and Rector.
+The coding standards are defined and automatically enforced by Mago.
 
 Each package comes with a DSL (Domain Specific Language) that provides an easy, functional API.
 All functions defined in DSL (usually in `functions.php` files) are following the same codding standards as PHP code.

documentation/contributing/guidelines.md

@@ -0,0 +1,71 @@
+php-version = "8.3"
+
+[source]
+paths = [
+    "bin",
+    "src",
+    "web/landing/bin",
+    "web/landing/src",
+    "web/landing/tests",
+]
+excludes = [
+    "**/vendor/**",
+    "**/var/**",
+    "**/extension/*/ext/build/**",
+    "**/extension/*/ext/run-tests.php",
+]
+
+[parser]
+enable-short-tags = false
+
+[linter]
+integrations = ["symfony", "phpunit"]
+
+[linter.rules]
+cyclomatic-complexity = { enabled = false }
+excessive-nesting = { enabled = false }
+excessive-parameter-list = { enabled = false }
+halstead = { enabled = false }
+kan-defect = { enabled = false }
+too-many-enum-cases = { enabled = false }
+too-many-methods = { enabled = false }
+too-many-properties = { enabled = false }
+class-name = { enabled = false }
+constant-name = { enabled = false }
+enum-name = { enabled = false }
+file-name = { enabled = false }
+function-name = { enabled = false }
+interface-name = { enabled = false }
+trait-name = { enabled = false }
+single-class-per-file = { enabled = false }
+no-boolean-flag-parameter = { enabled = false }
+literal-named-argument = { enabled = false }
+tagged-fixme = { enabled = false }
+tagged-todo = { enabled = false }
+prefer-static-closure = { enabled = false }
+prefer-arrow-function = { enabled = false }
+prefer-early-continue = { enabled = false }
+no-else-clause = { enabled = false }
+no-hash-comment = { enabled = false }
+no-empty-catch-clause = { enabled = false }
+no-isset = { enabled = false }
+no-nested-ternary = { enabled = false }
+no-assign-in-condition = { enabled = false }
+explicit-octal = { enabled = false }
+readable-literal = { enabled = false }
+no-redundant-final = { enabled = false }
+no-empty-loop = { enabled = false }
+no-empty = { enabled = false }
+loop-does-not-iterate = { enabled = false }
+no-debug-symbols = { enabled = false }
+no-multi-assignments = { enabled = false }
+identity-comparison = { enabled = false }
+strict-assertions = { enabled = false }
+assert-description = { enabled = false }
+use-specific-assertions = { enabled = false }
+prefer-first-class-callable = { enabled = false }
+final-controller = { enabled = false }
+prefer-interface = { enabled = false }
+no-redundant-else = { enabled = true, level = "warning" }
+no-redundant-variable = { enabled = true, level = "warning" }
+strict-types = { enabled = true, level = "error" }