vijaycs85/drupal-quality-checker

Setups code quality checking tools for Drupal project.

Maintainers

Details

github.com/vijaycs85/drupal-quality-checker

Homepage

Source

Issues

Installs: 188 416

Dependents: 5

Suggesters: 0

Security: 0

Stars: 52

Watchers: 5

Forks: 38

Open Issues: 13

Type:project

1.5.0 2021-05-12 13:35 UTC

Requires

MIT 424112ec4d1567775781d9149ab9f21db271cc5e

This package is auto-updated.

Last update: 2024-10-27 19:14:49 UTC

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 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. 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.

Sample

Pass

drupal-quality-checker-pass

Fail

drupal-quality-checker-fail

Demo

Implemented in Modal Configuration module.