qntn/drupal-quality-checker

Setups code quality checking tools for Drupal project.

9.2.1 2021-01-26 14:51 UTC

Requires

• composer/composer: ~2.0
• dealerdirect/phpcodesniffer-composer-installer: *
• drupal/coder: ^8.3
• ergebnis/composer-normalize: ^2.5
• friendsoftwig/twigcs: ^3.2
• mglaman/drupal-check: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.0
• phpro/grumphp: ^1.0
• sebastian/phpcpd: ^6.0

MIT

• Quentin Fonteneau

README

Overview

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

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

Install

1. Add vijaycs85/drupal-quality-checker to composer.json (like here) or just composer require --dev vijaycs85/drupal-quality-checker
2. Replace grumphp.yml in project's root directory (not Drupal root directory) with vendor/vijaycs85/drupal-quality-checker/grumphp.yml.dist

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. PHPLint
3. YAML Lint
4. Composer
5. Composer Normalize
6. JSONLint
7. PHP Copy/Paste Detector (CPD)
8. drupal-check

Long list of additional checks/validators available here.

Sample

Pass

Fail

Demo

Implemented in Modal Configuration module.