Replace php-cs-fixer with Laravel Pint

Author: stefanzweifel

.github/workflows/php-cs-fixer.yml

@@ -1,21 +1,25 @@
-name: Check & fix styling
+name: Fix PHP code style issues
 
-on: [push]
+on:
+  push:
+    paths:
+      - '**.php'
 
 jobs:
-  php-cs-fixer:
+  php-code-styling:
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: write
+
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.head_ref }}
 
-      - name: Run PHP CS Fixer
-        uses: docker://oskarstark/php-cs-fixer-ga
-        with:
-          args: --config=.php-cs-fixer.php --allow-risky=yes
+      - name: Fix PHP code style issues
+        uses: aglipanci/[email protected]
 
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4

.gitignore

@@ -3,4 +3,3 @@
 /.vscode
 /.vagrant
 .phpunit.result.cache
-.php-cs-fixer.cache

.php-cs-fixer.php

@@ -15,11 +15,11 @@
 class AddReleaseNotesToChangelogAction
 {
     public function __construct(
-        private readonly Markdown                                      $markdown,
-        private readonly FindUnreleasedHeading                         $findUnreleasedHeading,
-        private readonly FindSecondLevelHeadingWithText                $findSecondLevelHeadingWithText,
+        private readonly Markdown $markdown,
+        private readonly FindUnreleasedHeading $findUnreleasedHeading,
+        private readonly FindSecondLevelHeadingWithText $findSecondLevelHeadingWithText,
         private readonly PlaceReleaseNotesBelowUnreleasedHeadingAction $addNewReleaseNotesWithUnreleasedHeadingToChangelog,
-        private readonly PlaceReleaseNotesAtTheTopAction               $addNewReleaseToChangelog
+        private readonly PlaceReleaseNotesAtTheTopAction $addNewReleaseToChangelog
     ) {
     }
 
@@ -60,6 +60,7 @@ public function execute(string $originalChangelog, string $latestVersion, string
 
     /**
      * Check if a second-level heading for the latestVersion already exists in the document.
+     *
      * @throws ReleaseAlreadyExistsInChangelogException|Throwable
      */
     private function checkIfVersionAlreadyExistsInChangelog(Document $changelog, string $latestVersion): void

app/Actions/AddReleaseNotesToChangelogAction.php

@@ -13,8 +13,8 @@
 class PlaceReleaseNotesAtTheTopAction
 {
     public function __construct(
-        private readonly FindFirstSecondLevelHeading       $findFirstSecondLevelHeading,
-        private readonly CreateNewReleaseHeading           $createNewReleaseHeading,
+        private readonly FindFirstSecondLevelHeading $findFirstSecondLevelHeading,
+        private readonly CreateNewReleaseHeading $createNewReleaseHeading,
         private readonly InsertReleaseNotesInChangelogAction $insertReleaseNotesInChangelogAction
     ) {
     }

app/Actions/PlaceReleaseNotesAtTheTopAction.php

@@ -18,10 +18,10 @@
 class PlaceReleaseNotesBelowUnreleasedHeadingAction
 {
     public function __construct(
-        private readonly GenerateCompareUrl                    $generateCompareUrl,
-        private readonly FindSecondLevelHeadingWithText        $findPreviousVersionHeading,
+        private readonly GenerateCompareUrl $generateCompareUrl,
+        private readonly FindSecondLevelHeadingWithText $findPreviousVersionHeading,
         private readonly CreateNewReleaseHeadingWithCompareUrl $createNewReleaseHeading,
-        private readonly GitHubActionsOutput                   $gitHubActionsOutput,
+        private readonly GitHubActionsOutput $gitHubActionsOutput,
         private readonly InsertReleaseNotesInChangelogAction $insertReleaseNotesInChangelogAction
     ) {
     }
@@ -94,7 +94,7 @@ private function getLinkNodeFromHeading(Heading $unreleasedHeading): Link
         /** @var Link $linkNode */
         $linkNode = $unreleasedHeading->firstChild();
 
-        throw_if($linkNode === null, new LogicException("Can not find link node in unreleased heading."));
+        throw_if($linkNode === null, new LogicException('Can not find link node in unreleased heading.'));
 
         return $linkNode;
     }

app/Actions/PlaceReleaseNotesBelowUnreleasedHeadingAction.php

@@ -20,6 +20,7 @@ public function execute(Document $document, int $baseHeadingLevel): Document
 
         /**
          * @var array<Heading> $headings
+         *
          * @psalm-suppress InvalidArgument
          */
         $headings = iterator_to_array($headings);
@@ -44,7 +45,7 @@ public function execute(Document $document, int $baseHeadingLevel): Document
     }
 
     /**
-     * @param array<Heading> $headings
+     * @param  array<Heading>  $headings
      */
     public function findLowestHeadingLevel(array $headings): int|null
     {

app/Actions/ShiftHeadingLevelInDocumentAction.php

@@ -63,7 +63,6 @@ public function handle(AddReleaseNotesToChangelogAction $addReleaseNotesToChange
 
         $changelog = $this->getChangelogContent($pathToChangelog);
 
-
         try {
             $updatedChangelog = $addReleaseNotesToChangelog->execute(
                 originalChangelog: $changelog,
@@ -94,7 +93,7 @@ public function handle(AddReleaseNotesToChangelogAction $addReleaseNotesToChange
         }
     }
 
-    protected function getReleaseNotes(): null | string
+    protected function getReleaseNotes(): null|string
     {
         if ($this->option('parse-release-notes')) {
             return null;
@@ -103,7 +102,7 @@ protected function getReleaseNotes(): null | string
         return $this->option('release-notes') ?: $this->ask('What markdown Release Notes should be added to the CHANGELOG?');
     }
 
-    protected function getChangelogContent(string $pathToChangelog): bool | string
+    protected function getChangelogContent(string $pathToChangelog): bool|string
     {
         return file_get_contents($pathToChangelog);
     }

app/Commands/UpdateCommand.php

@@ -10,6 +10,6 @@ class ReleaseNotesCanNotBeplacedException extends Exception
 {
     public function __construct()
     {
-        parent::__construct("Release notes could not be placed. Is the CHANGELOG empty? Does it contain at least one heading?");
+        parent::__construct('Release notes could not be placed. Is the CHANGELOG empty? Does it contain at least one heading?');
     }
 }

app/Exceptions/ReleaseNotesCanNotBeplacedException.php

@@ -10,6 +10,6 @@ class ReleaseNotesNotProvidedException extends Exception
 {
     public function __construct()
     {
-        parent::__construct("Release Notes were not provided. Pass them through the `--release-notes`-option.");
+        parent::__construct('Release Notes were not provided. Pass them through the `--release-notes`-option.');
     }
 }