feat: P002827-13 Add drupal coding standards

CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.0]
+### Added
+- Added coding standards for `drupal`.
+- Added packages for `phpstan` for drupal based on [this documentation](https://www.drupal.org/docs/develop/development-tools/phpstan/getting-startedhttps://www.drupal.org/docs/develop/development-tools/phpstan/getting-started)
+  - `phpstan/phpstan`
+  - `phpstan/extension-installer`
+  - `mglaman/phpstan-drupal`
+  - `phpstan/phpstan-deprecation-rules`
+- Added package for `phpcs` based on (this documentation)[https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/coder/installing-coder]
+  - `drupal/coder`
+### Fixed
+- Mapping for drupal was added to prevent error that file is missing in `templates/mapping/project/drupal`.
+### Fixed
+- Magento 2 makes use of `phtml` moved triggered by for phpcs from default to magento2 scope.
+
 ## [3.0.3]
 ### Fixed
 - When running GrumPHP on an environment with the Redis PHP extension installed, it errored with `The package 

config/default/grumphp.yml

@@ -26,7 +26,7 @@ parameters:
 
   phpcs.enabled: true
   phpcs.standard: ./phpcs.xml
-  phpcs.triggered_by: [php,phtml]
+  phpcs.triggered_by: [php]
 
   phpcsfixer.enabled: false
   phpcsfixer.allow_risky: false

config/drupal/grumphp.yml

@@ -3,8 +3,4 @@ imports:
 
 # Extend git triggers with common Drupal constructs
 parameters:
-  git_blacklist.triggered_by: [ 'php', 'js', 'twig' ]
-
-#  securitychecker.allow_list:
-#    - CVE-2002-0121 # Add a jira ticket indicating when this vulnerability will be fixed (update/upgrade will be
-                     #    performed). Within that ticket explain this (new) vulnerability.
+  phpcs.triggered_by: [ 'php' , 'module' ]

config/drupal/phpmd.xml

@@ -4,8 +4,8 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 https://pmd.sourceforge.io/ruleset_xml_schema.xsd">
     <description>PHPMD rules for Drupal projects.</description>
-    <rule ref="./config/default/phpmd.xml" />
+    <rule ref="./vendor/youwe/testing-suite/config/default/phpmd.xml" />
 
     <!-- No overrides compared to default. Revisit this file and recreate default drupal rulesets for projects if needed.
      Note: seperate ruleset needed until https://github.com/phpmd/phpmd/issues/39 is resolved -->
-</ruleset>
+</ruleset>

config/drupal/ruleset.xml

@@ -2,8 +2,6 @@
 <ruleset name="Youwe/Drupal">
     <description>Youwe coding standard extensions for sniffing code in Drupal projects.</description>
 
-    <!-- Use default Youwe coding standards for PHP projects. -->
-    <rule ref="../default" />
     <!-- Additional Drupal-specific rulesets. -->
-
-</ruleset>
+    <rule ref="Drupal" />
+</ruleset>

config/magento2/grumphp.yml

@@ -18,6 +18,7 @@ parameters:
     - "<?php echo"
     - "Magento\\\\Framework\\\\App\\\\ObjectManager"
   git_blacklist.triggered_by: [ 'php', 'js', 'phtml' ]
+  phpcs.triggered_by: [ 'php' , 'phtml' ]
 
 #  securitychecker.allow_list:
 #    - CVE-2002-0121 # Add a jira ticket indicating when this vulnerability will be fixed (update/upgrade will be

grumphp.yml

@@ -5,7 +5,7 @@ parameters:
   composer.strict: false
   xmllint.ignore_patterns:
     - /^phpcs.xml$/
-    - /^phpmd.xml$/
+    - /(^|\/)phpmd\.xml$/
     - /^phpunit.xml$/
     - /^pdepend.xml$/
     - /^templates/

src/Installer/PackagesInstaller.php

@@ -55,6 +55,33 @@ class PackagesInstaller implements InstallerInterface
                 'updateDependencies' => true,
             ]
         ],
+        'drupal' => [
+            'drupal/coder' => [
+                'version' => '@stable',
+                'updateDependencies' => true,
+                'allowVersionOverride' => false,
+            ],
+            'phpstan/phpstan' => [
+                'version' => '@stable',
+                'updateDependencies' => true,
+                'allowVersionOverride' => false,
+            ],
+            'phpstan/extension-installer' => [
+                'version' => '@stable',
+                'updateDependencies' => true,
+                'allowVersionOverride' => false,
+            ],
+            'mglaman/phpstan-drupal' => [
+                'version' => '@stable',
+                'updateDependencies' => true,
+                'allowVersionOverride' => false,
+            ],
+            'phpstan/phpstan-deprecation-rules' => [
+                'version' => '@stable',
+                'updateDependencies' => true,
+                'allowVersionOverride' => false,
+            ],
+        ],
         'pimcore' => [
             'phpstan/phpstan' => [
                 'version' => '>=2.0',

src/ProjectTypeResolver.php

@@ -31,7 +31,7 @@ class ProjectTypeResolver
 
     /** @var array */
     private $mapping = [
-        'drupal-bundle' => 'drupal',
+        'drupal-module' => 'drupal',
         'drupal-project' => 'drupal',
         'magento-project' => 'magento2',
         'magento2-module' => 'magento2',

templates/files/drupal/grumphp.yml

@@ -1,2 +1,2 @@
 imports:
-  - resource: 'vendor/youwe/testing-suite/config/pimcore/grumphp.yml'
+  - resource: 'vendor/youwe/testing-suite/config/drupal/grumphp.yml'

templates/files/drupal/phpcs.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<ruleset name="YouweDrupal"
+<ruleset name="YouweMagento2"
          xmlns="http://pmd.sf.net/ruleset/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
@@ -9,5 +9,7 @@
     <!-- Append arg -s to phpcs to display the name of failed sniffs -->
     <arg value="s"/>
 
-    <!--<exclude-pattern>path/to/exclude/*</exclude-pattern>-->
-</ruleset>
+    <exclude-pattern>build</exclude-pattern>
+    <exclude-pattern>drush</exclude-pattern>
+    <exclude-pattern>.ddev</exclude-pattern>
+</ruleset>

templates/files/drupal/phpstan.neon

@@ -5,12 +5,6 @@ includes:
   # - phpstan-baseline.neon
 
 parameters:
+  level: 1
   paths:
-    - web
-
-    # Add any other project folder containing source files, e.g.
-    # - tests
-
-  excludePaths:
-    # Add any path you want to exclude (note, only files/folders within the configured `paths` are relevant to note here), e.g.:
-    # - tests/fixtures/*
+    - web/modules/custom

templates/mapping/project/drupal

@@ -0,0 +1,4 @@
+{drupal/,}grumphp.yml
+{drupal/,}phpcs.xml
+{drupal/,}phpmd.xml
+{drupal/,}phpstan.neon

tests/ProjectTypeResolverTest.php

@@ -26,7 +26,7 @@ class ProjectTypeResolverTest extends TestCase
      * @throws Exception
      */
     #[TestWith(data: ['some-type', 'default'], name: 'some-type')]
-    #[TestWith(data: ['drupal-bundle', 'drupal'], name: 'drupal-bundle')]
+    #[TestWith(data: ['drupal-module', 'drupal'], name: 'drupal-module')]
     #[TestWith(data: ['drupal-project', 'drupal'], name: 'drupal-project')]
     #[TestWith(data: ['magento-project', 'magento2'], name: 'magento-project')]
     #[TestWith(data: ['magento2-module', 'magento2'], name: 'magento2-module')]