https://github.com/vijaycs85/drupal-quality-checker
https://github.com/vijaycs85/drupal-quality-checker
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vijaycs85/drupal-quality-checker
- Owner: vijaycs85
- Created: 2017-12-10T12:02:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-12T10:06:27.000Z (almost 2 years ago)
- Last Synced: 2025-02-18T21:47:49.783Z (2 months ago)
- Size: 722 KB
- Stars: 52
- Watchers: 5
- Forks: 38
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Drupal Code Quality Checker
---
## Overview
Provides set of libraries to easily setup code quality checks based on [GrumPHP](https://github.com/phpro/grumphp) for Drupal module/theme/profile. Check out this [Lullabot article](https://www.lullabot.com/articles/how-enforce-drupal-coding-standards-git) 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](https://github.com/vijaycs85/modal_config/blob/8.x-1.x/composer.json#L21)) 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](https://github.com/phpro/grumphp/issues/416) when install/uninstall.
## Features
1. [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer) with Drupal standard.
1. [PHP Lint](http://www.icosaedro.it/phplint/)
1. [YAML Lint](http://www.yamllint.com/)
1. [Composer](https://github.com/composer/composer)
1. [Composer Normalize](https://github.com/ergebnis/composer-normalize)
1. [JSONLint](https://jsonlint.com/)
1. [PHP Copy/Paste Detector (CPD)](https://github.com/sebastianbergmann/phpcpd)
Long list of additional checks/validators available [here](https://github.com/phpro/grumphp/blob/master/doc/tasks.md#tasks-1).
## Sample
### Pass
### Fail
## Demo
Implemented in [Modal Configuration](https://github.com/vijaycs85/modal_config) module.