Replace Psalm with Phpstan (#19)

* Replace Psalm with PhpStan

* Update Workflows

* Make Phpstan happy

* Bump to Level 9

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

@@ -1,23 +1,11 @@
-name: Check & fix styling
+name: php-cs-fixer
 
-on: [push]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
 
 jobs:
   php-cs-fixer:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-        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: Commit changes
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: Fix styling
+    uses: stefanzweifel/reusable-workflows/.github/workflows/php-cs-fixer.yml@main

.github/workflows/phpstan.yml

@@ -0,0 +1,10 @@
+name: PHPStan
+
+on:
+  push
+
+jobs:
+  update_release_draft:
+    uses: stefanzweifel/reusable-workflows/.github/workflows/phpstan.yml@main
+    with:
+      php_version: '8.3'

.github/workflows/release-drafter.yml

@@ -7,8 +7,4 @@ on:
 
 jobs:
   update_release_draft:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: release-drafter/release-drafter@v5
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    uses: stefanzweifel/reusable-workflows/.github/workflows/release-drafter.yml@main

.github/workflows/update-changelog.yaml

@@ -6,23 +6,4 @@ on:
 
 jobs:
   update:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-        with:
-          ref: main
-
-      - name: Update Changelog
-        uses: stefanzweifel/changelog-updater-action@v1
-        with:
-          release-notes: ${{ github.event.release.body }}
-          latest-version: ${{ github.event.release.name }}
-
-      - name: Commit updated CHANGELOG
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          branch: main
-          commit_message: Update CHANGELOG
-          file_pattern: CHANGELOG.md
+    uses: stefanzweifel/reusable-workflows/.github/workflows/update-changelog.yml@main

composer.json

@@ -22,9 +22,9 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",
+        "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^10.0",
-        "rector/rector": "^0.15.17",
-        "vimeo/psalm": "^5.7"
+        "rector/rector": "^0.15.17"
     },
     "autoload": {
         "psr-4": {

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+	level: 9
+	paths:
+		- src
+		- tests

src/Renderer/Block/HtmlBlockRenderer.php

@@ -30,6 +30,7 @@ public function render(Node $node, ChildNodeRendererInterface $childRenderer): s
 
         // We ignore $node->getType() here, as we want to render all HTML blocks the same way.
 
+        /** @var string $htmlInput */
         $htmlInput = $this->config->get('html_input');
 
         return HtmlFilter::filter($node->getLiteral(), $htmlInput);

src/Renderer/Inline/HtmlInlineRenderer.php

@@ -28,6 +28,7 @@ public function render(Node $node, ChildNodeRendererInterface $childRenderer): s
     {
         HtmlInline::assertInstanceOf($node);
 
+        /** @var string $htmlInput */
         $htmlInput = $this->config->get('html_input');
 
         return HtmlFilter::filter($node->getLiteral(), $htmlInput);

src/Renderer/Inline/ImageRenderer.php

@@ -28,6 +28,7 @@ public function render(Node $node, ChildNodeRendererInterface $childRenderer): s
     {
         Image::assertInstanceOf($node);
 
+        /** @var array<string, string> $attrs */
         $attrs = $node->data->get('attributes');
 
         $forbidUnsafeLinks = ! $this->config->get('allow_unsafe_links');

src/Renderer/Inline/LinkRenderer.php

@@ -28,6 +28,7 @@ public function render(Node $node, ChildNodeRendererInterface $childRenderer): s
     {
         Link::assertInstanceOf($node);
 
+        /** @var array<string, string> $attrs */
         $attrs = $node->data->get('attributes');
 
         $forbidUnsafeLinks = ! $this->config->get('allow_unsafe_links');

src/Renderer/Inline/NewlineRenderer.php

@@ -35,6 +35,7 @@ public function render(Node $node, ChildNodeRendererInterface $childRenderer): s
                 return "\n";
             }
 
+            /** @phpstan-var string */
             return $this->config->get('renderer/soft_break');
         }
     }

src/Renderer/MarkdownRenderer.php

@@ -75,11 +75,13 @@ public function renderNodes(iterable $nodes): string
 
     public function getBlockSeparator(): string
     {
+        /** @phpstan-var string */
         return $this->environment->getConfiguration()->get('renderer/block_separator');
     }
 
     public function getInnerSeparator(): string
     {
+        /** @phpstan-var string */
         return $this->environment->getConfiguration()->get('renderer/inner_separator');
     }
 }

tests/MarkdownRendererExtensionTest.php

@@ -29,7 +29,7 @@ public function test_markdown_renderer_extension_works(string $markdown, array $
     }
 
     /**
-     * @return iterable<array<mixed>>
+     * @return \Iterator
      */
     public static function getTestData(): \Iterator
     {

tests/Renderer/Block/FencedCodeRendererTest.php

@@ -21,6 +21,9 @@ protected function setUp(): void
         $this->renderer = new FencedCodeRenderer();
     }
 
+    /**
+     * @param array<int> $fencedArgs
+     */
     #[Test]
     #[DataProvider('provide_fenced_code')]
     public function it_renders_fenced_code(array $fencedArgs, string $expected): void
@@ -41,6 +44,9 @@ public function it_renders_fenced_code(array $fencedArgs, string $expected): voi
         $this->assertEquals($expected, $result);
     }
 
+    /**
+     * @return array<string, array<string, array<int, int|string>|string>>
+     */
     public function provide_fenced_code(): array
     {
         return [

tests/Renderer/MarkdownRendererTest.php

@@ -40,6 +40,7 @@ public function it_renders_ast_to_markdown(): void
     #[Test]
     public function it_parses_and_renders_kitchen_sink(): void
     {
+        /** @var string $contentKitchenSink */
         $contentKitchenSink = file_get_contents(__DIR__ . '/../stubs/kitchen-sink.md');
         $contentKitchenSinkExpected = file_get_contents(__DIR__ . '/../stubs/kitchen-sink-expected.md');
 
@@ -53,6 +54,7 @@ public function it_parses_and_renders_kitchen_sink(): void
     #[Test]
     public function it_parses_kitchen_sink_and_parsing_the_result_again_returns_the_same_result(): void
     {
+        /** @var string $contentKitchenSink */
         $contentKitchenSink = file_get_contents(__DIR__ . '/../stubs/kitchen-sink.md');
         $contentKitchenSinkExpected = file_get_contents(__DIR__ . '/../stubs/kitchen-sink-expected.md');