Add code checks

Author: rincler

.github/linters/phpcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<ruleset name="super-linter">
+    <rule ref="PSR12">
+        <exclude name="PSR12.Properties.ConstantVisibility.NotFound" />
+    </rule>
+</ruleset>

.github/linters/phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    level: max
+    checkGenericClassInNonGenericObjectType: false
+    ignoreErrors:
+        - '#constructor invoked with#'
+        - '#FunctionVariant constructor expects#'

.github/workflows/ci.yml

@@ -10,11 +10,12 @@ jobs:
         php: ['7.1', '7.2', '7.3', '7.4', '8.0']
         prefer: ['lowest', 'stable']
 
-    name: PHP ${{ matrix.php }} with ${{ matrix.prefer }} composer prefer option
+    name: Test on PHP ${{ matrix.php }} with ${{ matrix.prefer }} composer prefer option
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout Code
+        uses: actions/checkout@v2
 
       - name: Install PHP
         uses: shivammathur/setup-php@v2
@@ -35,7 +36,30 @@ jobs:
 
       - name: Install dependencies
         if: steps.composer-cache.outputs.cache-hit != 'true'
-        run: composer update --prefer-${{ matrix.prefer }} --prefer-dist --no-progress --no-suggest
+        run: composer update --prefer-${{ matrix.prefer }} --prefer-dist --no-progress
 
       - name: Run tests
-        run: composer test
+        run: composer test
+
+  linter:
+    name: Linter
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.1
+
+      - name: Install dependencies
+        run: composer update --prefer-stable --prefer-dist --no-progress
+
+      - name: Lint Code
+        uses: github/super-linter@v3
+        env:
+          FILTER_REGEX_EXCLUDE: .*vendor.*
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_PHP_PSALM: false

README.md

@@ -12,13 +12,13 @@ This extension defines dynamic methods for `MyCLabs\Enum\Enum` subclasses.
 
 To use this extension, require it with [Composer](https://getcomposer.org)
 
-```
+```bash
 composer require --dev timeweb/phpstan-enum
 ```
 
 And include extension.neon in your project's PHPStan config
 
-```
+```yaml
 includes:
   - vendor/timeweb/phpstan-enum/extension.neon
 ```

composer.json

@@ -18,9 +18,9 @@
         }
     },
     "autoload-dev": {
-        "classmap": [
-            "tests/_fixture/"
-        ]
+        "psr-4": {
+            "Timeweb\\Tests\\PHPStan\\": "tests/"
+        }
     },
     "scripts": {
         "test": "phpunit"

tests/_fixture/EnumFixture.php renamed to tests/Fixture/EnumFixture.php

@@ -1,6 +1,12 @@
 <?php
 
-class EnumFixture extends MyCLabs\Enum\Enum
+declare(strict_types=1);
+
+namespace Timeweb\Tests\PHPStan\Fixture;
+
+use MyCLabs\Enum\Enum;
+
+class EnumFixture extends Enum
 {
     const MEMBER = 'member';
 

tests/Reflection/EnumMethodsClassReflectionExtensionTest.php

@@ -2,14 +2,17 @@
 
 declare(strict_types=1);
 
+namespace Timeweb\Tests\PHPStan\Reflection;
+
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Testing\TestCase;
 use PHPStan\Type\VerbosityLevel;
 use Timeweb\PHPStan\Reflection\EnumMethodReflection;
 use Timeweb\PHPStan\Reflection\EnumMethodsClassReflectionExtension;
+use Timeweb\Tests\PHPStan\Fixture\EnumFixture;
 
 /**
- * @coversDefaultClass Timeweb\PHPStan\Reflection\EnumMethodsClassReflectionExtension
+ * @coversDefaultClass \Timeweb\PHPStan\Reflection\EnumMethodsClassReflectionExtension
  */
 class EnumMethodsClassReflectionExtensionTest extends TestCase
 {
@@ -33,14 +36,17 @@ public function setUp(): void
      * @covers ::hasMethod
      * @dataProvider methodNameDataProvider
      */
-    public function testEnumMethodsCanBeFoundInEnumSubclasses(bool $expected, string $methodName)
+    public function testEnumMethodsCanBeFoundInEnumSubclasses(bool $expected, string $methodName): void
     {
         $classReflection = $this->broker->getClass(EnumFixture::class);
         $hasMethod = $this->reflectionExtension->hasMethod($classReflection, $methodName);
 
         $this->assertEquals($expected, $hasMethod);
     }
 
+    /**
+     * @return array[]
+     */
     public function methodNameDataProvider(): array
     {
         return [
@@ -52,7 +58,7 @@ public function methodNameDataProvider(): array
     /**
      * @covers ::hasMethod
      */
-    public function testEnumMethodsCannotBeFoundInNonEnumSubclasses()
+    public function testEnumMethodsCannotBeFoundInNonEnumSubclasses(): void
     {
         $classReflection = $this->broker->getClass(EnumFixture::class);
         $hasMethod = $this->reflectionExtension->hasMethod($classReflection, 'SOME_NAME');
@@ -62,9 +68,9 @@ public function testEnumMethodsCannotBeFoundInNonEnumSubclasses()
 
     /**
      * @covers ::getMethod
-     * @uses Timeweb\PHPStan\Reflection\EnumMethodReflection
+     * @uses \Timeweb\PHPStan\Reflection\EnumMethodReflection
      */
-    public function testEnumMethodReflectionCanBeObtained()
+    public function testEnumMethodReflectionCanBeObtained(): void
     {
         $classReflection = $this->broker->getClass(EnumFixture::class);
         $methodReflection = $this->reflectionExtension->getMethod($classReflection, 'SOME_NAME');
@@ -80,10 +86,10 @@ public function testEnumMethodReflectionCanBeObtained()
      * @covers \Timeweb\PHPStan\Reflection\EnumMethodReflection::isPublic
      * @covers \Timeweb\PHPStan\Reflection\EnumMethodReflection::getPrototype
      * @covers \Timeweb\PHPStan\Reflection\EnumMethodReflection::getVariants
-     * @uses Timeweb\PHPStan\Reflection\EnumMethodReflection
+     * @uses \Timeweb\PHPStan\Reflection\EnumMethodReflection
      * @dataProvider enumFixtureProperties
      */
-    public function testEnumMethodProperties(string $propertyName)
+    public function testEnumMethodProperties(string $propertyName): void
     {
         $classReflection = $this->broker->getClass(EnumFixture::class);
         $methodReflection = $this->reflectionExtension->getMethod($classReflection, $propertyName);
@@ -97,6 +103,9 @@ public function testEnumMethodProperties(string $propertyName)
         $this->assertSame(EnumFixture::class, $parametersAcceptor->getReturnType()->describe(VerbosityLevel::value()));
     }
 
+    /**
+     * @return string[][]
+     */
     public function enumFixtureProperties(): array
     {
         return [