Update linting

Author: gdebrauwer

.github/workflows/run-linting.yml

@@ -40,3 +40,4 @@ jobs:
             - name: Execute linting
               run: |
                 vendor/bin/php-cs-fixer fix --dry-run
+                vendor/bin/phpcs --colors --report-full

.php-cs-fixer.php

@@ -1,5 +1,6 @@
 <?php
 
+use AdamWojs\PhpCsFixerPhpdocForceFQCN\Fixer\Phpdoc\ForceFQCNFixer;
 use PhpCsFixer\Config;
 use PhpCsFixer\Finder;
 
@@ -177,6 +178,8 @@
     'unary_operator_spaces' => true,
     // In array declaration, there MUST be a whitespace after each comma.
     'whitespace_after_comma_in_array' => true,
+    // Force Fully-Qualified Class Name in docblocks
+    'AdamWojs/phpdoc_force_fqcn_fixer' => true,
 ];
 
 $finder = Finder::create()
@@ -191,5 +194,8 @@
     ->ignoreVCS(true);
 
 return (new Config())
+    ->registerCustomFixers([
+        new ForceFQCNFixer(),
+    ])
     ->setRules($rules)
     ->setFinder($finder);

composer.json

@@ -34,9 +34,11 @@
         "illuminate/support": "^7.0|^8.0|^9.0"
     },
     "require-dev": {
+        "adamwojs/php-cs-fixer-phpdoc-force-fqcn": "^2.0",
         "friendsofphp/php-cs-fixer": "^3.0",
         "orchestra/testbench": "^5.0|^6.0|^7.0",
-        "phpunit/phpunit": "^9.1"
+        "phpunit/phpunit": "^9.1",
+        "squizlabs/php_codesniffer": "^3.6"
     },
     "autoload": {
         "psr-4": {
@@ -51,8 +53,8 @@
     "scripts": {
         "test": "vendor/bin/phpunit",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
-        "lint": "vendor/bin/php-cs-fixer fix",
-        "lint-dry": "vendor/bin/php-cs-fixer fix --dry-run"
+        "lint": "vendor/bin/php-cs-fixer fix && vendor/bin/phpcs --colors --report-full",
+        "lint-dry": "vendor/bin/php-cs-fixer fix --dry-run && vendor/bin/phpcs --colors --report-full"
     },
     "config": {
         "sort-packages": true

phpcs.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<ruleset name="PSR2">
+    <description>The PSR2 coding standard.</description>
+
+    <rule ref="PSR2"/>
+
+    <rule ref="PSR1.Methods.CamelCapsMethodName">
+        <exclude-pattern>*/**/tests</exclude-pattern>
+    </rule>
+
+    <rule ref="Generic.Files.LineLength.TooLong">
+        <exclude-pattern>*/**/tests</exclude-pattern>
+        <exclude-pattern>*/**/src/Console/InstallCommand.php</exclude-pattern>
+        <exclude-pattern>*/**/src/*ServiceProvider.php</exclude-pattern>
+    </rule>
+
+    <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
+        <exclude-pattern>*/**/tests</exclude-pattern>
+    </rule>
+
+    <rule ref="Generic.PHP.ForbiddenFunctions">
+        <properties>
+            <property name="forbiddenFunctions" type="array" value="dd=>NULL,var_dump=>NULL,dump=>NULL"/>
+        </properties>
+    </rule>
+
+    <file>src/</file>
+    <file>tests/</file>
+
+    <exclude-pattern>vendor/</exclude-pattern>
+    <exclude-pattern>node_modules/</exclude-pattern>
+</ruleset>

src/VerificationCodeManager.php

@@ -115,7 +115,9 @@ protected function getNotificationClass()
         $notificationClass = config('verification-code.notification', VerificationCodeCreated::class);
 
         if (! is_subclass_of($notificationClass, VerificationCodeCreatedInterface::class)) {
-            throw new RuntimeException('The notification class must implement the `\NextApps\VerificationCode\Notifications\VerificationCodeCreatedInterface` interface');
+            $interface = VerificationCodeCreatedInterface::class;
+
+            throw new RuntimeException('The notification class must implement the `{$interface}` interface');
         }
 
         return $notificationClass;