ADD PHPStan to the QA tools

Author: AymDev

.github/workflows/testing.yml

@@ -39,3 +39,7 @@ jobs:
             # Run tests suite
             -   name: Run test suite
                 run: php vendor/bin/simple-phpunit --coverage-text
+
+            # Run PHPStan
+            -   name: Run PHPStan
+                run: php vendor/bin/phpstan

CHANGELOG.md

@@ -6,7 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-- support for **Symfony** v6
+ - support for **Symfony** v6
+ - **PHP CodeSniffer**, **PHP Compatibility**, **PHPStan** & **PHPStan strict rules** to the CI
 
 ## [2.0.0] - 2021-11-14
 ### Changed

composer.json

@@ -35,6 +35,9 @@
         "symfony/filesystem": "^5.1|^6.0",
         "squizlabs/php_codesniffer": "^3.6",
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
-        "phpcompatibility/php-compatibility": "^9.3"
+        "phpcompatibility/php-compatibility": "^9.3",
+        "phpstan/phpstan": "^1.2",
+        "phpstan/extension-installer": "^1.1",
+        "phpstan/phpstan-strict-rules": "^1.1"
     }
 }

phpstan.neon

@@ -0,0 +1,14 @@
+parameters:
+    level: 9
+    paths:
+        - src
+        - tests
+    bootstrapFiles:
+        - vendor/bin/.phpunit/phpunit-9.5-0/vendor/autoload.php
+    typeAliases:
+        converterConfig: 'array{name: string, type: string, options: mixed[]|null, extensions: class-string[]}'
+    ignoreErrors:
+        -
+            message: '~^Call to an undefined method [a-zA-Z0-9\\_]+::[a-zA-Z]+\(\).$~'
+            path: src/DependencyInjection/Configuration.php
+

src/AymdevCommonmarkBundle.php

@@ -14,7 +14,7 @@ class AymdevCommonmarkBundle extends Bundle
     /**
      * @codeCoverageIgnore
      */
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

src/DependencyInjection/AymdevCommonmarkExtension.php

@@ -15,7 +15,10 @@
  */
 class AymdevCommonmarkExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    /**
+     * @param mixed[] $configs
+     */
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);

src/DependencyInjection/Compiler/ConvertersPass.php

@@ -19,8 +19,9 @@ class ConvertersPass implements CompilerPassInterface
     /** @var Reference[] converter service IDs */
     private array $converters = [];
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
+        /** @var converterConfig[] $converters */
         $converters = $container->getParameter(self::PARAMETER_CONVERTERS);
 
         foreach ($converters as $name => $config) {
@@ -33,7 +34,10 @@ public function process(ContainerBuilder $container)
         $this->setupTwigExtension($container);
     }
 
-    private function registerConverters(array $converterConfig, ContainerBuilder $container): array
+    /**
+     * @param converterConfig $converterConfig
+     */
+    private function registerConverters(array $converterConfig, ContainerBuilder $container): void
     {
         // Create environment definition
         $environment = new ChildDefinition('aymdev_commonmark.environment.' . $converterConfig['type']);
@@ -69,8 +73,6 @@ private function registerConverters(array $converterConfig, ContainerBuilder $co
 
         // Save converter for later twig extension arguments setup
         $this->converters[$converterConfig['name']] = new Reference($converterConfig['name']);
-
-        return $converterConfig;
     }
 
     private function setupTwigExtension(ContainerBuilder $container): void

src/Twig/CommonMarkExtension.php

@@ -30,24 +30,29 @@ public function getFilters(): array
 
     public function convertMarkdown(?string $markdown, ?string $converterName = null): ?string
     {
+        if (null === $markdown) {
+            return null;
+        }
+
         // Single converter setup
         if ($converterName === null && count($this->serviceLocator->getProvidedServices()) === 1) {
-            /** @var MarkdownConverter $converter */
             $converterName = array_key_first($this->serviceLocator->getProvidedServices());
+
+            /** @var MarkdownConverter $converter */
             $converter = $this->serviceLocator->get($converterName);
             return $converter->convertToHtml($markdown);
         }
 
+        if (null === $converterName) {
+            return null;
+        }
+
         if (false === $this->serviceLocator->has($converterName)) {
             $message = 'The "%s" converter does not exists. Did you mean one of these ? %s';
             $availableConverters = implode(', ', array_keys($this->serviceLocator->getProvidedServices()));
             throw new \InvalidArgumentException(sprintf($message, $converterName, $availableConverters));
         }
 
-        if ($markdown === null) {
-            return null;
-        }
-
         /** @var MarkdownConverter $converter */
         $converter = $this->serviceLocator->get($converterName);
         return $converter->convertToHtml($markdown)->getContent();

tests/AymdevCommonmarkBundleTest.php

@@ -3,19 +3,19 @@
 namespace Tests\AymDev\CommonMarkBundle;
 
 use Aymdev\CommonmarkBundle\AymdevCommonmarkBundle;
-use Aymdev\CommonmarkBundle\DependencyInjection\AymdevCommonMarkExtension;
+use Aymdev\CommonmarkBundle\DependencyInjection\AymdevCommonmarkExtension;
 use PHPUnit\Framework\TestCase;
 
 class AymdevCommonmarkBundleTest extends TestCase
 {
     /**
      * Ensure the extension will be loaded
      */
-    public function testExtensionNameConsistency()
+    public function testExtensionNameConsistency(): void
     {
         $bundle = new AymdevCommonmarkBundle();
         $extension = $bundle->getContainerExtension();
 
-        self::assertInstanceOf(AymdevCommonMarkExtension::class, $extension);
+        self::assertInstanceOf(AymdevCommonmarkExtension::class, $extension);
     }
 }

tests/DependencyInjection/AymDevCommonmarkExtensionTest.php

@@ -2,7 +2,7 @@
 
 namespace Tests\AymDev\CommonMarkBundle\DependencyInjection;
 
-use Aymdev\CommonmarkBundle\DependencyInjection\AymdevCommonMarkExtension;
+use Aymdev\CommonmarkBundle\DependencyInjection\AymdevCommonmarkExtension;
 use Aymdev\CommonmarkBundle\DependencyInjection\Compiler\ConvertersPass;
 use League\CommonMark\Environment\Environment;
 use League\CommonMark\MarkdownConverter;
@@ -14,10 +14,10 @@ class AymDevCommonmarkExtensionTest extends TestCase
     /**
      * Asserts that the converters configuration is saved as a container parameter
      */
-    public function testDefaultConfiguration()
+    public function testDefaultConfiguration(): void
     {
         $container = new ContainerBuilder();
-        $extension = new AymdevCommonMarkExtension();
+        $extension = new AymdevCommonmarkExtension();
 
         $extension->load([], $container);
         self::assertNotNull($container->getParameter(ConvertersPass::PARAMETER_CONVERTERS));
@@ -26,24 +26,27 @@ public function testDefaultConfiguration()
     /**
      * Asserts the default services are correctly defined
      */
-    public function testDefaultServicesRegistration()
+    public function testDefaultServicesRegistration(): void
     {
         $container = new ContainerBuilder();
-        $extension = new AymdevCommonMarkExtension();
+        $extension = new AymdevCommonmarkExtension();
 
         $extension->load([], $container);
 
         // "empty" Environment
+        /** @var Environment $emptyEnvironment */
         $emptyEnvironment = $container->get('aymdev_commonmark.environment.empty');
         self::assertInstanceOf(Environment::class, $emptyEnvironment);
         self::assertCount(0, $emptyEnvironment->getExtensions());
 
         // CommonMark Environment
+        /** @var Environment $commonMarkEnvironment */
         $commonMarkEnvironment = $container->get('aymdev_commonmark.environment.commonmark');
         self::assertInstanceOf(Environment::class, $commonMarkEnvironment);
         self::assertNotCount(0, $commonMarkEnvironment->getExtensions());
 
         // GitHub Environment
+        /** @var Environment $githubEnvironment */
         $githubEnvironment = $container->get('aymdev_commonmark.environment.github');
         self::assertInstanceOf(Environment::class, $githubEnvironment);
         self::assertNotCount(0, $githubEnvironment->getExtensions());