Download the PHP package drupal/coder without Composer
On this page you can find all versions of the php package drupal/coder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package coder
Short Description Coder is a library to review Drupal code.
License GPL-2.0-or-later
Homepage https://www.drupal.org/project/coder
Informations about the package coder
Coder
Coder is a library for automated Drupal code reviews and coding standard fixes. It defines rules for PHP_CodeSniffer
Built-in support for:
- "Drupal": Coding Standards https://www.drupal.org/coding-standards
- "DrupalPractice": Best practices for Drupal module development
Online documentation: https://www.drupal.org/node/1419980
Note that Javascript support has been removed. To check and fix Javascript files please use ESLint and see the Drupal ESLint documentation.
Local installation in your Drupal project
For collaborating developer teams it makes sense to lock a Coder version with your other development dependencies locally. In your project where you have your composer.json file execute this:
composer require --dev drupal/coder
Then you can run Coder on your custom module code like this:
./vendor/bin/phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml web/modules/custom
To simplify execution it is highly recommended to use a settings file, see below.
Usage
Check Drupal coding standards
./vendor/bin/phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml web/modules/custom
Check Drupal best practices
./vendor/bin/phpcs --standard=DrupalPractice --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml web/modules/custom
Automatically fix coding standards
./vendor/bin/phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,info,txt,md,yml web/modules/custom
Store settings in a phpcs.xml.dist file
In order to save and commit your PHPCS settings to Git you can use a phpcs.xml.dist file in your project like this:
Then you can invoke phpcs without any options and it will read phpcs.xml.dist from the current directory. This can also be useful for Continuous Integration setups. Example:
./vendor/bin/phpcs -p
Working with Editors
Drupal Code Sniffer can be used with various editors.
Editors:
Automated Testing (PHPUnit + PHPCS + PHPStan)
Coder Sniffer comes with a PHPUnit test suite to make sure the sniffs work correctly. Use Composer to install the dependencies:
composer install
Then execute the tests:
./vendor/bin/phpunit
Then execute the coding standards checker on Coder itself:
./vendor/bin/phpcs
Then execute static analysis:
./vendor/bin/phpstan
Contributing
Please create an issue fork and merge request on drupal.org.
Thank you!
Maintainers
- Pieter Frenssen, https://www.drupal.org/u/pfrenssen
- Michael Welford, https://www.drupal.org/u/mikejw
- Klaus Purer, https://www.drupal.org/u/klausi
Credits
Juliette Reinders Folmer and Greg Sherwood, many sniffs are modified copies of their original work on PHPCS.
All versions of coder with dependencies
ext-mbstring Version *
dealerdirect/phpcodesniffer-composer-installer Version ^1.2
sirbrillig/phpcs-variable-analysis Version ^2.13
slevomat/coding-standard Version ^8.25.1
squizlabs/php_codesniffer Version ^4.0.1
symfony/yaml Version >=3.4.0