PHPackages                             axelerant/drupal-quality-checker - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. axelerant/drupal-quality-checker

ActiveComposer-plugin[Testing & Quality](/categories/testing)

axelerant/drupal-quality-checker
================================

Code quality checking tools for Drupal project.

v2.0.2(2mo ago)13197.9k↓21.8%9[6 issues](https://github.com/axelerant/drupal-quality-checker/issues)1proprietaryPHPCI passing

Since Nov 20Pushed 2mo ago3 watchersCompare

[ Source](https://github.com/axelerant/drupal-quality-checker)[ Packagist](https://packagist.org/packages/axelerant/drupal-quality-checker)[ Docs](https://github.com/axelerant/drupal-quality-checker)[ RSS](/packages/axelerant-drupal-quality-checker/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (20)Versions (20)Used By (1)

Package for Drupal Code Quality presets
=======================================

[](#package-for-drupal-code-quality-presets)

This has been customised from [vijaycs85/drupal-quality-checker](https://packagist.org/packages/vijaycs85/drupal-quality-checker) for Axelerant needs. Apart from a different template file, it uses the Axelerant logo.

Installation
------------

[](#installation)

*Upgrading from Beta 8?* Read [the instructions for changes](#upgrading-from-beta-8) 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
-----

[](#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](https://github.com/phpro/grumphp/blob/master/doc/commands.md).

Customising
-----------

[](#customising)

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

### Adding tasks

[](#adding-tasks)

There are various tasks you can add and customise in your grumphp.yml. Read the [online documentation for GrumPHP tasks](https://github.com/phpro/grumphp/blob/master/doc/tasks.md) to see the tasks you can use and configure.

### Forcing commit message format

[](#forcing-commit-message-format)

To configure commit message structure, use the [git\_commit\_message task](https://github.com/phpro/grumphp/blob/master/doc/tasks/git_commit_message.md). For example, to enforce the commit message contains the Jira issue ID, use the rule as the following snippet. More options are [documented online](https://github.com/phpro/grumphp/blob/master/doc/tasks/git_commit_message.md).

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

### Disable commit banners

[](#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

[](#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

[](#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

[](#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
----------------------

[](#more-about-scaffolding)

As described before, this package uses [`drupal/core-composer-scaffold`](https://github.com/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"](https://github.com/drupal/core-composer-scaffold#excluding-scaffold-files) section of the [documentation](https://github.com/drupal/core-composer-scaffold/blob/8.8.x/README.md) for the core-composer-scaffold plugin.

Upgrading from Beta 8
---------------------

[](#upgrading-from-beta-8)

GrumPHP 0.19 introduced [a breaking change](https://github.com/phpro/grumphp/releases/tag/v0.19.0) 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](https://github.com/axelerant/drupal-quality-checker/commit/e8d9414ce6ea046b0386115764db68e5251d8a58#diff-94c8df1b4af91d80f7417cad14bbe0e5) to understand what needs to be changed in your grumphp.yml file. Also, read more at the [release page for GrumPHP 0.19](https://github.com/phpro/grumphp/releases/tag/v0.19.0).

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

###  Health Score

55

—

FairBetter than 98% of packages

Maintenance78

Regular maintenance activity

Popularity42

Moderate usage in the ecosystem

Community23

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 63.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~128 days

Recently: every ~168 days

Total

19

Last Release

64d ago

Major Versions

v1.5.0 → v2.0.02026-03-16

### Community

Maintainers

![](https://www.gravatar.com/avatar/085aa457eb46e449e7045c81d904cb31e53009485f8926af78651ca6e0676fcb?d=identicon)[hussainweb](/maintainers/hussainweb)

---

Top Contributors

[![hussainweb](https://avatars.githubusercontent.com/u/1040271?v=4)](https://github.com/hussainweb "hussainweb (70 commits)")[![zeshanziya](https://avatars.githubusercontent.com/u/132985988?v=4)](https://github.com/zeshanziya "zeshanziya (25 commits)")[![rajeshreeputra](https://avatars.githubusercontent.com/u/19570710?v=4)](https://github.com/rajeshreeputra "rajeshreeputra (6 commits)")[![sbrindle](https://avatars.githubusercontent.com/u/25477746?v=4)](https://github.com/sbrindle "sbrindle (2 commits)")[![jashish24](https://avatars.githubusercontent.com/u/32076806?v=4)](https://github.com/jashish24 "jashish24 (1 commits)")[![mohit-rocks](https://avatars.githubusercontent.com/u/2618452?v=4)](https://github.com/mohit-rocks "mohit-rocks (1 commits)")[![bthirietcap](https://avatars.githubusercontent.com/u/33827005?v=4)](https://github.com/bthirietcap "bthirietcap (1 commits)")[![skippednote](https://avatars.githubusercontent.com/u/2114712?v=4)](https://github.com/skippednote "skippednote (1 commits)")[![vishalkhode1](https://avatars.githubusercontent.com/u/81069167?v=4)](https://github.com/vishalkhode1 "vishalkhode1 (1 commits)")[![woredeyonas](https://avatars.githubusercontent.com/u/37066614?v=4)](https://github.com/woredeyonas "woredeyonas (1 commits)")[![happy047](https://avatars.githubusercontent.com/u/55045861?v=4)](https://github.com/happy047 "happy047 (1 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

---

Tags

drupalgitgrumphpphpcs

### Embed Badge

![Health badge](/badges/axelerant-drupal-quality-checker/health.svg)

```
[![Health](https://phpackages.com/badges/axelerant-drupal-quality-checker/health.svg)](https://phpackages.com/packages/axelerant-drupal-quality-checker)
```

###  Alternatives

[youwe/testing-suite

Contains Youwe's default testing packages for php.

13176.9k8](/packages/youwe-testing-suite)[wp-cli/wp-cli-tests

WP-CLI testing framework

422.7M87](/packages/wp-cli-wp-cli-tests)[acquia/orca

A tool for testing a company's software packages together in the context of a realistic, functioning, best practices Drupal build

32902.4k](/packages/acquia-orca)[drupal/core-dev

require-dev dependencies from drupal/drupal; use in addition to drupal/core-recommended to run tests from drupal/core.

2021.0M277](/packages/drupal-core-dev)[vijaycs85/drupal-quality-checker

Setups code quality checking tools for Drupal project.

52192.3k4](/packages/vijaycs85-drupal-quality-checker)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)