drupol/drupal-conventions

Drupal conventions for coding.

Maintainers

Details

github.com/drupol/drupal-conventions

Source

Issues

Fund package maintenance!
drupol

Installs: 21 619

Dependents: 3

Suggesters: 0

Security: 0

Stars: 24

Watchers: 4

Forks: 1

Open Issues: 4

2.0.1 2021-06-02 05:28 UTC

Requires

Suggests

MIT 3de7a6be8df16395144daaf84ce2a212fc702155

drupalphpcsCoding Standardphp-cs-fixerCoding Style

This package is auto-updated.

Last update: 2024-10-29 05:40:14 UTC

README

Latest Stable Version Stars Total Downloads Build Status License Say Thanks! Donate!

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 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 :-)