project drupal-quality-checker

vijaycs85/drupal-quality-checker

Setups code quality checking tools for Drupal project.

# Drupal Code Quality Checker

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., _(*1)

Note: This library aim to help contributed/custom Drupal module/theme/profile hosted in individual git repository., _(*2)

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., _(*3)

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

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., _(*5)

Sample

Pass

, _(*6)

Fail

, _(*7)

Demo

Implemented in Modal Configuration module., _(*8)