Add PhpStan (#7)

* Add phpstan

* Bump to Level 9

* Update Code to satisfy Phpstan

* Update Workflows

* Update run-tests.yml

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

@@ -1,23 +1,8 @@
-name: Check & fix styling
+name: php-cs-fixer
 
-on: [push]
+on:
+  push:
 
 jobs:
   php-cs-fixer:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        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: 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/run-tests.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.github/workflows/update-changelog.yaml

@@ -6,23 +6,4 @@ on:
 
 jobs:
   update:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-        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

@@ -20,6 +20,7 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",
+        "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^9.5 | ^10"
     },
     "autoload": {

phpstan.neon

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

src/MarkExtension.php

@@ -16,6 +16,7 @@ class MarkExtension implements ConfigurableExtensionInterface
 {
     public function register(EnvironmentBuilderInterface $environment): void
     {
+        /** @var string $char */
         $char = $environment->getConfiguration()->get('mark/character');
 
         $environment

src/Renderer/MarkRenderer.php

@@ -18,6 +18,7 @@ class MarkRenderer implements NodeRendererInterface
      */
     public function render(Node $node, ChildNodeRendererInterface $childRenderer): HtmlElement
     {
+        /** @var array<string, string> $attrs */
         $attrs = $node->data->get('attributes');
 
         return new HtmlElement('mark', $attrs, $childRenderer->renderNodes($node->children()));

tests/MarkExtensionTest.php

@@ -10,7 +10,7 @@
 
 class MarkExtensionTest extends TestCase
 {
-    public function getParser($character = '='): CommonMarkConverter
+    public function getParser(string $character = '='): CommonMarkConverter
     {
         $converter = new CommonMarkConverter([
             'mark' => [
@@ -41,6 +41,9 @@ public function test(string $source, string $expected, string $character): void
         );
     }
 
+    /**
+     * @return array<string, array<string>>
+     */
     public static function getSourceAndExpectedOutputs(): array
     {
         return [

tests/Renderer/MarkRendererTest.php

@@ -20,7 +20,7 @@ protected function setUp(): void
     }
 
     /** @test */
-    public function it_renders_mark()
+    public function it_renders_mark(): void
     {
         $inline = new Mark();
         $inline->data->set('attributes/id', 'foo');
@@ -29,9 +29,10 @@ public function it_renders_mark()
 
         $result = $this->renderer->render($inline, $fakeRenderer);
 
-        $this->assertTrue($result instanceof HtmlElement);
+        $this->assertInstanceOf(HtmlElement::class, $result);
         $this->assertEquals('mark', $result->getTagName());
-        $this->assertStringContainsString('::children::', $result->getContents(true));
         $this->assertEquals(['id' => 'foo'], $result->getAllAttributes());
+        /** @phpstan-ignore-next-line  */
+        $this->assertStringContainsString('::children::', $result->getContents(false));
     }
 }