drupol/drupal-conventions

Drupal conventions for coding.

2.0.1 2021-06-02 05:28 UTC

Requires

• php: >= 7.4
• drupal/coder: ^8.3.13
• drupol/php-conventions: ^5
• drupol/phpcsfixer-configs-drupal: ^2

Suggests

• symplify/coding-standard: The LineLength fixer needs this library. Only PHP >= 7.

MIT

• Pol Dellaiera

• drupal
• phpcs
• Coding Standard
• php-cs-fixer
• Coding Style

README

Drupal conventions

This tool will check your code against Drupal's coding standard.

It's based on GrumPHP and comes with a default configuration tailored for Drupal development.

The following checks are triggered:

• Drupal coder code sniffer's checks
• Custom PHP CS Fixer configuration
• PHPLint
• YAMLlint
• JSONlint

Drupal 7 and 8 are supported.

Installation

composer require --dev drupol/drupal-conventions

If you're not using GrumPHP

Manually add to your composer.json file:

Drupal 8

    "extra": {
        "grumphp": {
            "config-default-path": "vendor/drupol/drupal-conventions/config/drupal8/grumphp.yml"
        }
    }

Drupal 7

    "extra": {
        "grumphp": {
            "config-default-path": "vendor/drupol/drupal-conventions/config/drupal7/grumphp.yml"
        }
    }

If you're using GrumPHP already

Edit the file grumphp.yml.dist or grumphp.yml and add on the top it:

Drupal 8

imports:
  - { resource: vendor/drupol/drupal-conventions/config/drupal8/grumphp.yml }

Drupal 7

imports:
  - { resource: vendor/drupol/drupal-conventions/config/drupal7/grumphp.yml }

To add an extra Grumphp task:

imports:
  - { resource: vendor/drupol/drupal-conventions/config/drupal7/grumphp.yml }

parameters:
  extra_tasks:
    phpunit:
      always_execute: false

In conjunction with extra_tasks, use skip_tasks to skip tasks if needed.

Contributing

Feel free to contribute to this library by sending Github pull requests. I'm quite reactive :-)