fivejars/drupal-quality-check

Setups code quality checking tools for FiveJars Drupal project.

dev-master 2024-04-16 11:00 UTC

Requires

• php: >=8.2
• acquia/coding-standards: ^2.0
• dealerdirect/phpcodesniffer-composer-installer: *
• drupal/coder: 8.3.23
• ergebnis/composer-normalize: >=2.5
• ergebnis/phpstan-rules: ^2.1
• friendsoftwig/twigcs: ^6.4
• mglaman/phpstan-drupal: ^1.1
• php-parallel-lint/php-parallel-lint: ^1.3
• phpcompatibility/php-compatibility: ^9.3
• phpmd/phpmd: ^2.15
• phpmetrics/phpmetrics: ^3.0@rc
• phpro/grumphp-shim: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• povils/phpmnd: ^3.3
• sebastian/phpcpd: >=4.0
• squizlabs/php_codesniffer: ^3.8

GPL-2.0-or-later

README

Overview

Provides set of libraries to easily setup code quality checks based on GrumPHP for Drupal project.

Install

1. Add this package using composer composer require --dev fivejars/drupal-quality-check
2. Copy configuration files(grumphp.yml.dist, phpmd.xml.dist, phpstan.neon.dist) in project's root directory (not Drupal root directory) without .dist suffix(grumphp.yml, phpmd.xml, phpstan.neon).
3. Overview and change configuration according to your project requirements.
4. Copy the scripts section from composer.scripts.json to your project composer.json or merge it using wikimedia/composer-merge-plugin.

That's it. Now, GrumPHP tasks run on every git commit. Also you can to run other tasks using composer scripts.

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

Composer Scripts

1. composer grumphp - Run GrumPHP for the project files added to Git
2. composer phpmetrics - Generate PHP Metrics for project files from configured directories(see composer.scripts.json in the package root)
3. composer phpstan - Run PHPStan for the project files from configured directories(see phpstan.neon in your project root)
4. composer phpcs YOUR_DIR - Run PHPCS on the directory from command argument.
5. composer phpcbf YOUR_DIR - Run PHPCBF on the directory from command argument.
6. composer phpmd - Run PHPMD for the project files from configured directories(see phpmd.xml in your project root)
7. composer phpmnd - Run PHPMD for the project files from configured directories(see composer.scripts.json in the package root)
8. composer twigcs YOUR_DIR - Run TwigCS on the directory from command argument.

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)
8. PHPStan
9. TwigCS
10. PHPCompatibility
11. PHPMetrics

Long list checks/validators available here.