miteshmap/drupal-quality-checker

Setups code quality checking tools for Drupal project.

1.0.3 2023-05-17 22:09 UTC

Requires

• dealerdirect/phpcodesniffer-composer-installer: *
• drupal/coder: >=8.3
• drupal/core-composer-scaffold: ^9.4 || ^10.0
• ergebnis/composer-normalize: >=2.5
• friendsoftwig/twigcs: >=5.0
• php-parallel-lint/php-parallel-lint: >=1.0
• phpro/grumphp-shim: ^1.16
• sebastian/phpcpd: >=4.0

MIT

• Mitesh Patel
• Vijaya Chandran Mani

README

Overview

Provides set of libraries to easily setup code quality checks based on GrumPHP for Drupal module/theme/profile. Check out this Lullabot article for more details.

Note: This library aim to help contributed/custom Drupal module/theme/profile hosted in individual git repository.

Install

1. Add following code to composer.json under extra.drupal-scaffold.allowed-packages section.

    "extra": {
        "drupal-scaffold": {
            "allowed-packages": [
                "miteshmap/drupal-quality-checker"
            ],
        }
    }
   

2. composer require "miteshmap/drupal-quality-checker:^1.0"
3. copy grumphp.yml.dist in project's root directory (not Drupal root directory) with ./grumphp.yml

That's it. Now, all tasks (listed below) run on every git commit.

Note: As part of install, GrumPHP adds pre-commit hook to repository. Existing pre-commit might get destroyed when install/uninstall.

Features

1. PHPCS with Drupal standard.
2. PHP Lint
3. YAML Lint
4. Composer
5. Composer Normalize
6. JSONLint
7. PHP Copy/Paste Detector (CPD)

Long list of additional checks/validators available here.