Merge pull request #1194 from ergebnis/feature/synchronize

Enhancement: Synchronize with `ergebnis/php-package-template`
ergebnis · Nov 17, 2024 · eeb58f1 · eeb58f1
2 parents c231a02 + 928c8d0
commit eeb58f1
Show file tree

Hide file tree

Showing 17 changed files with 524 additions and 1,044 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -11,6 +11,6 @@
 /composer.lock                  export-ignore
 /infection.json                 export-ignore
 /Makefile                       export-ignore
-/psalm-baseline.xml             export-ignore
-/psalm.xml                      export-ignore
+/phpstan-baseline.neon          export-ignore
+/phpstan.neon                   export-ignore
 /rector.php                     export-ignore
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# CONTRIBUTING
+# Contributing
 
 We use [GitHub Actions](https://github.com/features/actions) as a continuous integration system.
 
@@ -85,7 +85,7 @@ to run a security analysis.
 
 ## Static Code Analysis
 
-We use [`vimeo/psalm`](https://github.com/vimeo/psalm) to statically analyze the code.
+We use [`phpstan/phpstan`](https://github.com/phpstan/phpstan) to statically analyze the code.
 
 Run
 
@@ -95,15 +95,15 @@ make static-code-analysis
 
 to run a static code analysis.
 
-We also use the baseline feature of [`vimeo/psalm`](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file).
+We also use the baseline feature of [`phpstan/phpstan`](https://phpstan.org/user-guide/baseline).
 
 Run
 
 ```sh
 make static-code-analysis-baseline
 ```
 
-to regenerate the baseline in [`../psalm-baseline.xml`](../psalm-baseline.xml).
+to regenerate the baseline in [`../phpstan-baseline.neon`](../phpstan-baseline.neon).
 
 :exclamation: Ideally, the baseline should shrink over time.
 

diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -14,7 +14,7 @@ updates:
     open-pull-requests-limit: 10
     package-ecosystem: "composer"
     schedule:
-      interval: "daily"
+      interval: "weekly"
     versioning-strategy: "increase"
 
   - commit-message:
@@ -26,4 +26,4 @@ updates:
     open-pull-requests-limit: 10
     package-ecosystem: "github-actions"
     schedule:
-      interval: "daily"
+      interval: "weekly"
diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml
@@ -44,6 +44,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 
@@ -110,6 +113,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 
@@ -125,13 +131,8 @@ jobs:
         with:
           dependencies: "${{ matrix.dependencies }}"
 
-      - name: "Install dependencies with phive"
-        uses: "ergebnis/.github/actions/phive/install@1.9.2"
-        with:
-          trust-gpg-keys: "0xC00543248C87FB13,0x033E5F8D801A2F8D"
-
       - name: "Run ergebnis/composer-normalize"
-        run: ".phive/composer-normalize --ansi --dry-run"
+        run: "composer normalize --ansi --dry-run"
 
       - name: "Cache cache directory for friendsofphp/php-cs-fixer"
         uses: "actions/cache@v4.1.2"
@@ -178,6 +179,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 
@@ -196,7 +200,7 @@ jobs:
       - name: "Install dependencies with phive"
         uses: "ergebnis/.github/actions/phive/install@1.9.2"
         with:
-          trust-gpg-keys: "0xC00543248C87FB13,0x033E5F8D801A2F8D"
+          trust-gpg-keys: "0x033E5F8D801A2F8D"
 
       - name: "Run maglnet/composer-require-checker"
         run: ".phive/composer-require-checker check --ansi --config-file=$(pwd)/composer-require-checker.json --verbose"
@@ -233,6 +237,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 
@@ -285,6 +292,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 
@@ -344,6 +354,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 
@@ -394,6 +407,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 
@@ -409,8 +425,8 @@ jobs:
         with:
           dependencies: "${{ matrix.dependencies }}"
 
-      - name: "Run vimeo/psalm"
-        run: "vendor/bin/psalm --config=psalm.xml --output-format=github --shepherd --show-info=false --stats --threads=4"
+      - name: "Run phpstan/phpstan"
+        run: "vendor/bin/phpstan --ansi --configuration=phpstan.neon --memory-limit=-1"
 
   tests:
     name: "Tests"
@@ -454,6 +470,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 

diff --git a/.github/workflows/renew.yaml b/.github/workflows/renew.yaml
@@ -41,6 +41,9 @@ jobs:
       - name: "Validate composer.json and composer.lock"
         run: "composer validate --ansi --strict"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 

diff --git a/.github/workflows/update.yaml b/.github/workflows/update.yaml
@@ -36,6 +36,9 @@ jobs:
       - name: "Show diff"
         run: "git diff test/Fixture/Vendor/Composer/schema.json"
 
+      - name: "Determine composer root version"
+        uses: "ergebnis/.github/actions/composer/determine-root-version@1.9.2"
+
       - name: "Determine composer cache directory"
         uses: "ergebnis/.github/actions/composer/determine-cache-directory@1.9.2"
 

diff --git a/.phive/phars.xml b/.phive/phars.xml
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="composer-normalize" version="^2.42.0" installed="2.42.0" location="./.phive/composer-normalize" copy="false"/>
   <phar name="composer-require-checker" version="^3.8.0" installed="3.8.0" location="./.phive/composer-require-checker" copy="false"/>
 </phive>
diff --git a/Makefile b/Makefile
@@ -2,13 +2,13 @@
 it: refactoring coding-standards security-analysis static-code-analysis tests ## Runs the refactoring, coding-standards, security-analysis, static-code-analysis, and tests targets
 
 .PHONY: code-coverage
-code-coverage: vendor ## Collects coverage from running unit tests with phpunit/phpunit
+code-coverage: vendor ## Collects code coverage from running unit tests with phpunit/phpunit
 	vendor/bin/phpunit --configuration=test/Unit/phpunit.xml --coverage-text
 
 .PHONY: coding-standards
-coding-standards: phive vendor ## Lints YAML files with yamllint, normalizes composer.json with ergebnis/composer-normalize, and fixes code style issues with friendsofphp/php-cs-fixer
+coding-standards: vendor ## Lints YAML files with yamllint, normalizes composer.json with ergebnis/composer-normalize, and fixes code style issues with friendsofphp/php-cs-fixer
 	yamllint -c .yamllint.yaml --strict .
-	.phive/composer-normalize
+	composer normalize
 	vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --show-progress=dots --verbose
 
 .PHONY: dependency-analysis
@@ -25,7 +25,7 @@ mutation-tests: vendor ## Runs mutation tests with infection/infection
 
 .PHONY: phive
 phive: .phive ## Installs dependencies with phive
-	PHIVE_HOME=.build/phive phive install --trust-gpg-keys 0xC00543248C87FB13,0x033E5F8D801A2F8D
+	PHIVE_HOME=.build/phive phive install --trust-gpg-keys 0x033E5F8D801A2F8D
 
 .PHONY: refactoring
 refactoring: vendor ## Runs automated refactoring with rector/rector
@@ -41,14 +41,14 @@ security-analysis: vendor ## Runs a security analysis with composer
 	composer audit
 
 .PHONY: static-code-analysis
-static-code-analysis: vendor ## Runs a static code analysis with vimeo/psalm
-	vendor/bin/psalm --config=psalm.xml --clear-cache
-	vendor/bin/psalm --config=psalm.xml --show-info=false --stats --threads=4
+static-code-analysis: vendor ## Runs a static code analysis with phpstan/phpstan
+	vendor/bin/phpstan clear-result-cache --configuration=phpstan.neon
+	vendor/bin/phpstan --configuration=phpstan.neon --memory-limit=-1
 
 .PHONY: static-code-analysis-baseline
-static-code-analysis-baseline: vendor ## Generates a baseline for static code analysis with vimeo/psalm
-	vendor/bin/psalm --config=psalm.xml --clear-cache
-	vendor/bin/psalm --config=psalm.xml --set-baseline=psalm-baseline.xml
+static-code-analysis-baseline: vendor ## Generates a baseline for static code analysis with phpstan/phpstan
+	vendor/bin/phpstan clear-result-cache --configuration=phpstan.neon
+	vendor/bin/phpstan --allow-empty-baseline --configuration=phpstan.neon --generate-baseline=phpstan-baseline.neon --memory-limit=-1
 
 .PHONY: tests
 tests: vendor ## Runs unit tests with phpunit/phpunit

diff --git a/README.md b/README.md
@@ -7,7 +7,6 @@
 [![Update](https://github.com/ergebnis/json-normalizer/workflows/Update/badge.svg)](https://github.com/ergebnis/json-normalizer/actions)
 
 [![Code Coverage](https://codecov.io/gh/ergebnis/json-normalizer/branch/main/graph/badge.svg)](https://codecov.io/gh/ergebnis/json-normalizer)
-[![Type Coverage](https://shepherd.dev/github/ergebnis/json-normalizer/coverage.svg)](https://shepherd.dev/github/ergebnis/json-normalizer)
 
 [![Latest Stable Version](https://poser.pugx.org/ergebnis/json-normalizer/v/stable)](https://packagist.org/packages/ergebnis/json-normalizer)
 [![Total Downloads](https://poser.pugx.org/ergebnis/json-normalizer/downloads)](https://packagist.org/packages/ergebnis/json-normalizer)

diff --git a/composer.json b/composer.json
@@ -31,16 +31,20 @@
   },
   "require-dev": {
     "composer/semver": "^3.4.3",
+    "ergebnis/composer-normalize": "^2.44.0",
     "ergebnis/data-provider": "^3.3.0",
     "ergebnis/license": "^2.5.0",
     "ergebnis/php-cs-fixer-config": "^6.37.0",
     "ergebnis/phpunit-slow-test-detector": "^2.16.1",
     "fakerphp/faker": "^1.24.0",
     "infection/infection": "~0.26.6",
+    "phpstan/extension-installer": "^1.4.3",
+    "phpstan/phpstan": "^1.12.10",
+    "phpstan/phpstan-deprecation-rules": "^1.2.1",
+    "phpstan/phpstan-phpunit": "^1.4.0",
+    "phpstan/phpstan-strict-rules": "^1.6.1",
     "phpunit/phpunit": "^9.6.19",
-    "psalm/plugin-phpunit": "~0.19.0",
-    "rector/rector": "^1.2.10",
-    "vimeo/psalm": "^5.26.1"
+    "rector/rector": "^1.2.10"
   },
   "suggest": {
     "composer/semver": "If you want to use ComposerJsonNormalizer or VersionConstraintNormalizer"
@@ -58,7 +62,9 @@
   "config": {
     "allow-plugins": {
       "composer/package-versions-deprecated": true,
-      "infection/extension-installer": true
+      "ergebnis/composer-normalize": true,
+      "infection/extension-installer": true,
+      "phpstan/extension-installer": true
     },
     "audit": {
       "abandoned": "report"
@@ -68,5 +74,14 @@
     },
     "preferred-install": "dist",
     "sort-packages": true
+  },
+  "extra": {
+    "branch-alias": {
+      "dev-main": "4.6-dev"
+    },
+    "composer-normalize": {
+      "indent-size": 2,
+      "indent-style": "space"
+    }
   }
 }