coderkakarrot/drupal-code-scanner

Setups code quality checking tools for Drupal project.

1.0.0 2020-08-31 20:16 UTC

Requires

• composer/composer: ~1.0
• dealerdirect/phpcodesniffer-composer-installer: *
• drupal/coder: ^8.3
• ergebnis/composer-normalize: ^2.5
• php-parallel-lint/php-parallel-lint: ^1.0
• phpro/grumphp: ^0.18
• sebastian/phpcpd: ^3.0

MIT

• Pratik kamble

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 coderkakarrot/drupal-code-scanner to composer.json (like here) or just composer require --dev coderkakarrot/drupal-code-scanner
2. Replace grumphp.yml in project's root directory (not Drupal root directory) with vendor/coderkakarrot/drupal-code-scanner/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.