HACKING: add instructions about installing the Drupal style in PHP_CodeSniffer
[tweeper.git] / HACKING
1 The code follows the Drupal coding standards:
2 https://www.drupal.org/coding-standards
3
4 Style compliance can be checked using the Coder Sniffer extension to the PEAR
5 PHP_CodeSniffer project, for instructions about how to install Coder Sniffer
6 see https://www.drupal.org/node/1419988
7
8 TL;DR: install drupla/coder and enable the Drupal coding standard in
9 PHP_CodeSniffer:
10   
11   $ composer global require drupal/coder
12   $ export PATH="$HOME/.config/composer/vendor/bin:$PATH"
13   $ phpcs --config-set installed_paths $HOME/.config/composer/vendor/drupal/coder/coder_sniffer/
14
15 And then use this command to check the style:
16
17   $ phpcs --standard=Drupal .