qntn/drupal-quality-checker

Setups code quality checking tools for Drupal project.

Maintainers

Details

gitlab.com/q__nt_n/drupal-quality-checker

Homepage

Source

Issues

Installs: 296

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Forks: 0

Type:project

pkg:composer/qntn/drupal-quality-checker

9.2.1 2021-01-26 14:51 UTC

Requires

MIT 794c008f7acb39c07c44a25c94bb869d29802142

This package is auto-updated.

Last update: 2025-10-27 00:20:33 UTC

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

drupal-quality-checker-pass

Fail

drupal-quality-checker-fail

Demo

Implemented in Modal Configuration module.