carcheky/grumphp-drupal-check

Execute drupal check in a grumphp task.

1.0.0 2022-06-28 08:32 UTC

Requires

• mglaman/drupal-check: ^1
• phpro/grumphp: ^1

GPL-2.0-or-later

• Carcheky

README

This repository adds a task for GrumPHP that launchs drupal-check. During a commit check Drupal code for deprecations and discover bugs via static analysis. If a deprecated code is detected, it won't pass.

Installation

Install it using composer:

# Usage

1) Add the extension in your grumphp.yml file:
```yaml
extensions:
  - GrumphpDrupalCheck\ExtensionLoader
```

2) Add drupal check to the tasks:
```
tasks:
  drupalcheck:
    drupal_root: ~
    exclude_dir: ~
```
Optionally, configure the path to the Drupal root. This fallback option can be used if drupal-check could not identify Drupal root from the provided path(s). This is useful when testing a module as opposed to a Drupal installation.

Optionally, configure exclude files and directories. Wildcards work. Separate multiple excluded directories with commas, no spaces. e.g.: */tests/codeception/acceptance/*.php
(thanks to https://github.com/district09/grumphp-drupal-check)