axelerant/drupal-quality-checker

Code quality checking tools for Drupal project.

v1.4.0 2024-05-09 12:35 UTC

Requires

• composer-plugin-api: ^2.0
• dealerdirect/phpcodesniffer-composer-installer: *
• drupal/coder: ^8.3.7
• friendsoftwig/twigcs: ^4.0 || ^5.0 || ^6.0
• mglaman/phpstan-drupal: ^1.2
• php-parallel-lint/php-parallel-lint: ^1.2
• phpcompatibility/php-compatibility: ^9.0
• phpmd/phpmd: ^2.8
• phpro/grumphp-shim: ^2.0

Requires (Dev)

• composer/composer: ^2.7

proprietary

• Hussain Abbas

README

This has been customised from vijaycs85/drupal-quality-checker for Axelerant needs. Apart from a different template file, it uses the Axelerant logo.

Installation

Upgrading from Beta 8? Read the instructions for changes you need to make to grumphp.yml.dist.

composer require --dev axelerant/drupal-quality-checker

This will add the plugin to your project and copy the default configuration files. These files are:

• grumphp.yml.dist
• phpcs.xml.dist
• phpmd.xml.dist
• phpstan.neon.dist

Since these are .dist files, the plugin will overwrite them on every composer install. If you mean to customize the default settings, then we recommend that you rename them to remove the .dist suffix. As such, it is a good idea to add these .dist files to your .gitignore file.

Usage

No additional steps required, but if git hooks aren't fired, run php ./vendor/bin/grumphp git:init. For additional commands, look at grumhp's documentation.

Customising

Almost all customising begins with first copying the grumphp.yml.dist file to your project. Make sure you have the file.

Adding tasks

There are various tasks you can add and customise in your grumphp.yml. Read the online documentation for GrumPHP tasks to see the tasks you can use and configure.

Forcing commit message format

To configure commit message structure, use the git_commit_message task. For example, to enforce the commit message contains the Jira issue ID, use the rule as the following snippet. More options are documented online.

# grumphp.yml
grumphp:
  tasks:
    git_commit_message:
      matchers:
        Must contain issue number: /JIRA-\d+/

Disable commit banners

GrumPHP supports banners to celebrate (or scold) on your commit. This is fun but it is possible it gets on your nerves. If you don’t want it, edit the grumphp.yml file and replace the following parameters:

# grumphp.yml
grumphp:
    ascii: ~

You could even disable specific ones like this:

# grumphp.yml
grumphp:
    ascii:
        succeeded: ~

Overwrite phpmd ruleset

Copy the ruleset to the project root first

cp vendor/axelerant/drupal-quality-checker/phpmd.xml.dist phpmd.xml

Edit it as per your needs and commit. Remember to modify the grumphp.yml file with the new path.

# grumphp.yml
grumphp:
  tasks:
    phpmd:
      ruleset: ['phpmd.xml']

Customise phpcs rules

Copy the ruleset to the project root first

cp vendor/axelerant/drupal-quality-checker/phpcs.xml.dist phpcs.xml

Edit it as per your needs and commit. Remember to modify the grumphp.yml file with the new path.

# grumphp.yml
grumphp:
  tasks:
    phpcs:
      standard: ['phpcs.xml']

Customise phpstan rules

Copy the ruleset to the project root first

cp vendor/axelerant/drupal-quality-checker/phpstan.neon.dist phpstan.neon

Edit it as per your needs and commit. Remember to modify the grumphp.yml file with the new path.

# grumphp.yml
grumphp:
  tasks:
    phpstan:
      configuration: phpstan.neon

More about scaffolding

As described before, this package uses drupal/core-composer-scaffold plugin to scaffold a few files to the project root. This is not required but there is a good chance you are already using it if you're building a Drupal site.

The scaffolding operation runs with every composer operation and overwrites files. Only the file grumphp.yml.dist is not overwritten during subsequent operations. If you are customising any of the other configuration files and don't want the updates to overwrite your changes, you can override the behaviour in your composer.json file. For example, to skip phpmd.xml.dist from being overwritten, add this to your composer.json:

  "name": "my/project",
  ...
  "extra": {
    "drupal-scaffold": {
      "file-mapping": {
        "[project-root]/phpmd.xml.dist": false
      }
    }
  }

For more details, read the "Excluding Scaffold files" section of the documentation for the core-composer-scaffold plugin.

Upgrading from Beta 8

GrumPHP 0.19 introduced a breaking change to the structure of the YAML file. The template in this repository is updated as per the new structure. However, you would need to change the YML files on your projects before you update to Beta 9 or later.

Fortunately, the change is simple and in many cases would only require a one line change. Rename the parameters section to grumphp. Our default template contains two parameters which still need to remain under parameters. They are git_dir and bin_dir. Look at the diff of the change to understand what needs to be changed in your grumphp.yml file. Also, read more at the release page for GrumPHP 0.19.

Lastly, you can watch this video where I upgrade this on a project. Link: https://youtu.be/XoFJfBcZF58