kunal-sin/drupal-quality-checker

Code quality checker for Drupal based projects.

Drupal Code Quality Checker

---

Overview

This composer package will provide some basic code quality checks before committing code by using https://github.com/phpro/grumphp. Check out this Lullabot article for more details.

This has been customised from vijaycs85/drupal-quality-checker for Innoraft needs.

Install

1. Add innoraft/drupal-quality-checker to composer.json or just composer require --dev innoraft/drupal-quality-checker
2. Replace grumphp.yml in project's root directory (not Drupal root directory) with vendor/innoraft/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.

Out of the box

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.

ESLint task Setup

1. Go to custom theme folder and add eslint package with npm

npm install eslint --save-dev
npm install eslint-config-airbnb --save-dev

2. Now run this command at project's root directory

cp vendor/innoraft/drupal-quality-checker/eslintrc.json.dist .eslintrc.json

3. Update bin key for eslint task under grumphp.yml file with relative address to eslint's bin file.

Stylelint task Setup

1. Go to custom theme folder and add stylelint package with npm

npm install stylelint --save-dev

2. Now run this command at project's root directory

cp vendor/innoraft/drupal-quality-checker/stylelintrc.json.dist .stylelintrc.json

3. Update bin key for eslint task under grumphp.yml file with relative address to eslint's bin file.