Fix various issues for extension projects.

Author: matthijs-va

README.md

@@ -34,38 +34,45 @@ For an extension:
 }
 ```
 
-For an extension (to check only for D9 deprecations):
-
-```json
-"grumphp": {
-    "config-default-path": "vendor/digipolisgent/qa-drupal/configs/grumphp-extension-d9.yml"
-}
-```
-
 Now install this package and its requirements by executing execute following command:
 <pre><code>composer require --dev digipolisgent/qa-drupal:^1.0</code></pre>
 
 
 # Configuration
 
-**This section only applies to the site and extension configuration of GrumPHP.**
+## General
+
+If required you can extend or override the provided configuration file of a task.
+Simply create the matching configuration file in the root of your project.
 
-You can optionally extend or override the task configuration files by creating
-them in your project root. For example: create a `phpcs.xml` or `phpcs.local.xml`
-file to override the configuration provided by this package.
+For example, to override the provided `phpcs.xml` file you can either create a
+`phpcs.xml` or `phpcs.local.xml` file. Note that the latter one should only be
+used for changes that shouldn't be comitted.
 
-Note that Yaml and Neon files will be merged with your local files. So if you create
-a `phpstan.neon` file it will be merged with the `phpstan.neon` file of this package.
+Yaml and Neon files will extend (merged into) the provided configuration file by default.
+Create a `.env` or `.env.local` file and add following contents to change this behaviour:
 
-To prevent this, create a `.env` or `.env.local` file and add following contents:
 ```
-PHPSTAN_SKIP_PACKAGE_GLOBAL=1
+[FILENAME]_SKIP_[TYPE]=1
 ```
 
-The skip variable name is always the same `[FILENAME]_SKIP_[TYPE]`, wherin `[FILENAME]`
-if the file name and `[TYPE]` is either:
+Wherein `[FILENAME]` matches the configuration filename and `[TYPE]` is either:
 
-- `LOCAL` to skip `phpstan.local.neon`.
-- `PROJECT` to skip `phpstan.neon`.
-- `PACKAGE_TYPE` to skip `phpstan-extension.neon` (if in an extension) of this package.
-- `PACKAGE_GLOBAL` to skip `phpstan.neon` of this package.
+- `LOCAL` to skip for example your `phpstan.local.neon` file.
+- `PROJECT` to skip for example your `phpstan.neon` file.
+- `PACKAGE_TYPE` to skip for example the provided `phpstan-extension.neon` or `phpstan-site.neon` file.
+- `PACKAGE_GLOBAL` to skip for example the provided `phpstan.neon` file.
+
+Other file types cannot be merged and will just override all other less specific files.
+
+
+## PHPStan in deprecations only mode
+
+Create a `phpstan.neon` file and add following contents to ignore everything except deprecations.
+
+```
+parameters:
+  customRulesetUsed: true
+  ignoreErrors:
+    - '#^(?:(?!deprecated).)*$#'
+```

configs/grumphp-extension-d9.yml

@@ -50,7 +50,7 @@ parameters:
       max_body_width: 80
       max_subject_width: 80
       matchers:
-        - "/^([A-Z]+-\\d+(, [A-Z]+-\\d+): )?(Add|Change|Fix|Update|Remove) /"
+        - "/^([A-Z]+-\\d+(, [A-Z]+-\\d+)*: )?(Add|Change|Fix|Update|Remove) /"
       case_insensitive: false
     phpcpd:
       names_exclude:
@@ -93,6 +93,8 @@ parameters:
     phpstan:
       configuration: .phpstan.qa-drupal.neon
       level: 4
+      ignore_patterns:
+        - "#^tests/#"
       triggered_by:
         - php
         - inc

configs/grumphp-extension.yml

@@ -16,9 +16,11 @@
 
   <rule ref="rulesets/codesize.xml">
     <exclude name="CyclomaticComplexity" />
+    <exclude name="ExcessiveClassComplexity" />
     <exclude name="ExcessiveMethodLength" />
     <exclude name="ExcessiveParameterList" />
     <exclude name="NPathComplexity" />
+    <exclude name="TooManyMethods" />
     <exclude name="TooManyPublicMethods" />
   </rule>
 

configs/phpmd.xml

@@ -7,6 +7,7 @@ parameters:
   reportUnmatchedIgnoredErrors: false
   ignoreErrors:
     - '#Unsafe usage of new static\(\)#'
-    - '#\Drupal calls should be avoided in classes#'
+    - '#\\Drupal calls should be avoided in classes#'
+    - '#Method Drupal\\Core\\Form\\FormBuilderInterface::getForm\(\) invoked with#'
   excludes_analyse:
     - '*/node_modules/*'

configs/phpstan-extension-d9.neon

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- TODO set checkForUnintentionallyCoveredCode="true" once https://www.drupal.org/node/2626832 is resolved. -->
-<phpunit bootstrap="../drupal/core/tests/bootstrap.php" colors="true"
+<phpunit bootstrap="../drupal/core/tests/bootstrap.php"
+         printerClass="Drupal\Tests\Listeners\HtmlOutputPrinter"
+         colors="true"
          beStrictAboutTestsThatDoNotTestAnything="true"
          beStrictAboutOutputDuringTests="true"
-         beStrictAboutChangesToGlobalState="true"
-         printerClass="Drupal\Tests\Listeners\HtmlOutputPrinter">
+         beStrictAboutChangesToGlobalState="true">
 
   <php>
     <ini name="error_reporting" value="32767"/>
@@ -37,11 +38,17 @@
     <whitelist>
       <directory suffix=".php">./</directory>
       <exclude>
+        <directory>./vendor</directory>
         <directory suffix=".api.php">./</directory>
         <directory suffix="Test.php">./</directory>
         <directory suffix="TestBase.php">./</directory>
         <directory suffix="TestCase.php">./</directory>
       </exclude>
     </whitelist>
   </filter>
+
+  <logging>
+    <log type="coverage-html" target="build/coverage" />
+    <log type="coverage-clover" target="build/logs/clover.xml"/>
+  </logging>
 </phpunit>

configs/phpstan.neon

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- TODO set checkForUnintentionallyCoveredCode="true" once https://www.drupal.org/node/2626832 is resolved. -->
-<phpunit bootstrap="web/core/tests/bootstrap.php" colors="true"
+<phpunit bootstrap="web/core/tests/bootstrap.php"
+         printerClass="Drupal\Tests\Listeners\HtmlOutputPrinter"
+         colors="true"
          beStrictAboutTestsThatDoNotTestAnything="true"
          beStrictAboutOutputDuringTests="true"
-         beStrictAboutChangesToGlobalState="true"
-         printerClass="Drupal\Tests\Listeners\HtmlOutputPrinter">
+         beStrictAboutChangesToGlobalState="true">
 
   <php>
     <ini name="error_reporting" value="32767"/>
@@ -46,4 +47,9 @@
       </exclude>
     </whitelist>
   </filter>
+
+  <logging>
+    <log type="coverage-html" target="build/coverage" />
+    <log type="coverage-clover" target="build/logs/clover.xml"/>
+  </logging>
 </phpunit>

configs/phpunit-extension.xml

@@ -185,7 +185,7 @@ protected function getTaskConfigFileInfo(TaskInterface $task)
         }
         elseif ($task instanceof Phpunit) {
             $info = [
-                'filename' => 'phpmd',
+                'filename' => 'phpunit',
                 'extension' => 'xml',
                 'type' => self::FILETYPE_XML,
             ];

configs/phpunit-site.xml

@@ -21,17 +21,18 @@ public function __construct($name, $suite_namespace)
         parent::__construct('', $name);
 
         // Get the project root.
-        $root = dirname(__DIR__, 6);
+        $reflection = new \ReflectionClass(get_class($this));
+        $root = dirname($reflection->getFileName(), 7);
 
         if (!file_exists($root . '/web/index.php')) {
             // The project is an extension, add all tests.
             $this->addTestsBySuiteNamespace($root, $suite_namespace);
         } else {
             // The project is a site, add the tests of all custom extensions.
             $roots = [
-                $root . '/web/modules/custom',
-                $root . '/web/themes/custom',
-                $root . '/web/profiles/custom',
+                "$root/web/modules/custom",
+                "$root/web/themes/custom",
+                "$root/web/profiles/custom",
             ];
 
             foreach ($roots as $root) {
@@ -50,7 +51,14 @@ public function __construct($name, $suite_namespace)
      */
     protected function addTestsBySuiteNamespace($root, $suite_namespace)
     {
+        $vendor = "$root/vendor";
+
         foreach (drupal_phpunit_find_extension_directories($root) as $extension_name => $dir) {
+            if (strpos($dir, $vendor) === 0) {
+                // Exclude the vendor directory.
+                continue;
+            }
+
             $tests_path = "$dir/tests/src/$suite_namespace";
 
             if (is_dir($tests_path)) {