change: Migrate static analysis to Mago

.gitattributes

@@ -11,5 +11,4 @@
 *.dist export-ignore
 *.md export-ignore
 *.yml export-ignore
-.php-cs-fixer.dist.php export-ignore
 Taskfile.yml export-ignore

.github/workflows/static-analysis.yml

@@ -5,30 +5,53 @@ on:
     branches: ['main']
 
 jobs:
-  phpstan:
+  mago:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # https://github.com/actions/checkout/releases/tag/v6.0.2
       - uses: shivammathur/setup-php@7c071dfe9dc99bdf297fa79cb49ea005b9fcadbc # https://github.com/shivammathur/setup-php/releases/tag/2.37.1
         with:
-          php-version: 8.4
+          php-version: 8.5
           extensions: -pdo_mysql, -mysqli
       - run: composer update --prefer-stable --prefer-dist --no-interaction
-      - run: composer phpstan
-
-  php-cs-fixer:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # https://github.com/actions/checkout/releases/tag/v6.0.2
-        with:
-          ref: ${{ github.head_ref }}
-      - name: 'Run PHP CS fixer'
-        uses: ./.github/actions/php-cs-fixer
-        with:
-          workspace: ${{ github.workspace }}
-          args: --config=.php-cs-fixer.dist.php --allow-risky=yes
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-      - name: 'Commit CS fixes'
-        uses: craftzing/git-auto-commit-action@778341af668090896ca464160c2def5d1d1a3eb0
-        with:
-          commit_message: Fix code style violations
+      # Mago is installed through Composer, but the package is just a thin wrapper. By checking the version, we force
+      # the wrapper to download the binary before running actual checks in order not to pollute the check output...
+      - run: composer mago -- --version
+      - run: composer lint:check
+        id: lint
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - run: composer format:check
+        id: format
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - run: composer analyse:check
+        id: analyse
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: 'Fail upon detected issues'
+        if: |
+          steps.lint.outcome == 'failure' || 
+          steps.format.outcome == 'failure' || 
+          steps.analyse.outcome == 'failure'
+        env:
+          LINT_OUTCOME: ${{ steps.lint.outcome }}
+          FORMAT_OUTCOME: ${{ steps.format.outcome }}
+          ANALYSE_OUTCOME: ${{ steps.analyse.outcome }}
+        run: |
+          if [ "$LINT_OUTCOME" == "failure" ]; then
+            echo "::error title=Lint::Linter detected issues."
+          fi
+
+          if [ "$FORMAT_OUTCOME" == "failure" ]; then
+            echo "::error title=Format::Formatter detected files needing formatting."
+          fi
+
+          if [ "$ANALYSE_OUTCOME" == "failure" ]; then
+            echo "::error title=Analyse::Analyzer detected issues."
+          fi
+
+          exit 1

.github/workflows/test.yml

@@ -22,4 +22,4 @@ jobs:
           coverage: pcov
           extensions: -pdo_mysql, -mysqli
       - run: composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
-      - run: composer coverage:summary
+      - run: composer test:coverage

.gitignore

@@ -2,5 +2,3 @@
 /vendor
 /composer.lock
 /.phpunit.result.cache
-/.php_cs.cache
-/.php-cs-fixer.cache

Taskfile.yml

@@ -58,4 +58,4 @@ tasks:
       - for:
           var: versions
           split: ','
-        cmd: docker compose exec php-{{ .ITEM }} composer phpunit
+        cmd: docker compose exec php-{{ .ITEM }} composer test

composer.json

@@ -24,14 +24,13 @@
         "fakerphp/faker": "^1.24"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^3.75",
+        "carthage-software/mago": "^1.29.0",
         "illuminate/collections": "^10.10|^11.0|^12.0",
         "illuminate/console": "^10.10|^11.0|^12.0",
         "illuminate/container": "^10.10|^11.0|^12.0",
         "illuminate/contracts": "^10.10|^11.0|^12.0",
         "illuminate/support": "^10.10|^11.0|^12.0",
         "orchestra/testbench": "^9.9",
-        "phpstan/phpstan": "^2.1",
         "phpunit/phpunit": "^11.5",
         "saloonphp/saloon": "^3.13"
     },
@@ -63,26 +62,29 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "scripts": {
-        "cs:check": "PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --verbose --dry-run",
-        "cs:fix": "PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --verbose",
-        "phpstan": "vendor/bin/phpstan analyse --memory-limit=2G --ansi",
+        "mago": "vendor/bin/mago --colors=always",
         "phpunit": "vendor/bin/phpunit --colors=always --display-phpunit-deprecations --display-deprecations",
-        "test": [
-            "@composer cs:check",
-            "@composer phpstan",
-            "@composer phpunit"
+        "lint:check": "@composer mago -- lint --minimum-fail-level=warning --reporting-format=rich",
+        "lint:fix": "@composer mago -- lint --fix",
+        "format:check": "@composer mago -- format --dry-run",
+        "format:fix": "@composer mago -- format",
+        "analyse:check": "@composer mago -- analyse --minimum-fail-level=warning --reporting-format=rich",
+        "static-analysis:check": [
+            "@composer lint:check",
+            "@composer format:check",
+            "@composer analyse:check"
         ],
-        "coverage:summary": "@composer phpunit -- --coverage-text",
-        "coverage:report": "@composer phpunit -- --coverage-html=.reports/coverage"
+        "static-analysis:fix": [
+            "@composer lint:fix",
+            "@composer format:fix"
+        ],
+        "test": "@composer phpunit",
+        "test:coverage": "@composer phpunit -- --coverage-text",
+        "test:report": "@composer phpunit -- --coverage-html=.reports/coverage"
     },
     "extra": {
         "branch-alias": {
             "dev-main": "1.0.x-dev"
-        },
-        "laravel": {
-            "providers": [
-                "Craftzing\\TestBench\\Laravel\\ServiceProvider"
-            ]
         }
     }
 }

mago.toml

@@ -0,0 +1,41 @@
+#:schema https://mago.carthage.software/1.29.0/schema.json
+# For full documentation, see https://mago.carthage.software/tools/overview
+version = "1"
+php-version = "8.4.0"
+
+[source]
+workspace = "."
+paths = ["src"]
+includes = ["vendor"]
+excludes = []
+
+[source.glob]
+literal-separator = true
+
+[formatter]
+preset = "psr-12"
+print-width = 9999 # Horizontal limits are considered a guideline, not a requirement
+space-around-assignment-in-declare = false
+inline-empty-constructor-braces = true
+trailing-comma = true
+preserve-breaking-argument-list = true
+preserve-breaking-parameter-list = true
+preserve-breaking-array-like = true
+preserve-breaking-attribute-list = true
+preserve-breaking-member-access-chain = true
+
+[linter]
+integrations = ["phpunit"]
+
+[linter.rules]
+no-boolean-flag-parameter = { enabled = false }
+too-many-methods = { exclude = ["src/**/*Test.php"] }
+literal-named-argument = { exclude = ["src/**/*Test.php"] }
+prefer-test-attribute = { enabled = true }
+
+[analyzer]
+excludes = ["src/**/*Test.php"]
+ignore = [
+    "mixed-argument",
+    "mixed-assignment",
+]

src/Factories/ImmutableFactory.php

@@ -14,6 +14,7 @@
 
 /**
  * @template TClass of object
+ * @mago-expect lint:too-many-methods
  */
 abstract class ImmutableFactory
 {
@@ -34,7 +35,6 @@ final public function __construct(
      */
     public function state(array $state): static
     {
-        // @phpstan-ignore-next-line return.type
         return new static($this->faker, [...$this->state, ...$state], $this->count);
     }
 
@@ -43,7 +43,6 @@ public function state(array $state): static
      */
     public function times(int $count): static
     {
-        // @phpstan-ignore-next-line return.type
         return new static($this->faker, $this->state, $count);
     }
 
@@ -64,7 +63,7 @@ private function resolveValue(mixed $value): mixed
             return array_map($this->resolveValue(...), iterator_to_array($value));
         }
 
-        if (! $value instanceof self) {
+        if (!$value instanceof self) {
             return $value;
         }
 
@@ -102,7 +101,7 @@ public function rawMany(array $attributes = []): array
      */
     public function rawCollection(array $attributes = []): Collection
     {
-        return Collection::times($this->count, fn (): array => $this->raw($attributes));
+        return Collection::times($this->count, fn(): array => $this->raw($attributes));
     }
 
     /**
@@ -129,6 +128,6 @@ public function makeMany(array $attributes = []): array
      */
     public function makeCollection(array $attributes = []): Collection
     {
-        return Collection::times($this->count, fn (): mixed => $this->makeOne($attributes));
+        return Collection::times($this->count, fn(): mixed => $this->makeOne($attributes));
     }
 }