CLI tool for running checks on a Drupal code base
This package is auto-updated.
Last update: 2021-10-20 18:28:30 UTC
Built on PHPStan, this static analysis tool will check for correctness (e.g. using a class that doesn't exist), deprecation errors, and more.
Why? While there are many static analysis tools out there, none of them run with the Drupal context in mind. This allows checking contrib modules for deprecation errors thrown by core.
Are you ready for Drupal 9? Check out our Drupal 9 Readiness instructions for details on how this tool can help.
- PHP >=7.2
You can install this in your project using Composer as a development dependency like so:
composer require mglaman/drupal-check --dev
You can also install this globally using Composer like so:
composer global require mglaman/drupal-check
Refer to Composer's documentation on how to ensure global binaries are in your PATH: https://getcomposer.org/doc/00-intro.md#manual-installation.
This tool works on all Drupal code, but must be executed within the root directory of a Drupal project..
You can run this tool within any Drupal project. But, for best results, create a fresh Drupal directory on the latest Drupal:
composer create-project drupal-composer/drupal-project:8.x-dev drupal --no-interaction --stability=dev cd drupal
drupal-check [OPTIONS] [DIRS]
OPTIONS- See "Options" for allowed values. Specify multiples in sequence, e.g.
DIRS- One or more directories within the root of a Drupal project.
-dCheck deprecations (default)
-eExclude directories. Wildcards work. Separate multiple excluded directories with commas, no spaces. e.g.: */tests/codeception/acceptance/*.php
--drupal-rootPath to Drupal root. Fallback option if drupal-check could not identify Drupal root from the provided path(s).
Check the address contrib module:
Check the address contrib module for deprecations:
drupal-check -d web/modules/contrib/address
Check the address contrib module for analysis:
drupal-check -a web/modules/contrib/address
Check the address contrib module for both deprecations and analysis:
drupal-check -ad web/modules/contrib/address
You can run Drupal Check from VSCode using this extension: https://marketplace.visualstudio.com/items?itemName=bbeversdorf.drupal-check
The code can be found at: https://github.com/bbeversdorf/vscode-drupal-check
See what feature requests are most popular in the Issue queue: https://github.com/mglaman/drupal-check/issues.
Submit issues and feature requests here: https://github.com/mglaman/drupal-check/issues.
There are conflicts with dependencies shared with other libraries that might be installed on a Drupal project:
- This tool does not work with BLT 9: https://github.com/mglaman/drupal-check/issues/9
- If you run into issues with other libraries, please submit an issue to this project.
See the CONTRIBUTING.md.