#Introduction Sniff files for the ThinkUp project and PHP CodeSniffer - based on a mirror of the GPL'd Drupal CS project: http://drupal.org/project/drupalcs
I intend to customize this sniffer codebase to make it work for ThinkUp's style guide. Below is the original readme for the (now no longer maintained) Drupal code sniffing code that this is based on.
Drupal Code Sniffer
Drupal Code Sniffer (drupalcs) is a coding standard validation tool for Drupal and contributed modules/themes.
Online documentation: http://drupal.org/node/1419980
Requirements:
-
PEAR
-
PHPCS
-
Install PEAR ( http://pear.php.net/manual/en/installation.php )
-
Install PHPCS ( http://pear.php.net/package/PHP_CodeSniffer )
-
Sym-link the drupalcs directory into the standards folder for PHP_CodeSniffer. The code for that looks like this:
Please see the online documentation for more detailed instructions:
http://drupal.org/node/1419988
While drupalcs can be used as a standalone set of rules for PHP_CodeSniffer, drush command support is included to facilitate ease of use, installation, and leveraging of drush features such as site aliasing.
Extract the contents of the drupalcs project into one of the locations specified in the drush README.txt COMMANDS section, such as the subdirectory of the .drush folder in your home directory. For other alternatives, please see http://drupal.org/node/1419988
$> phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme /path/to/drupal_module
$> drush drupalcs sites/all/modules/custom
Drupal Code Sniffer can be used with various editors.
Editors:
eclipse: http://drupal.org/node/1420004 Komodo: http://drupal.org/node/1419996 Netbeans: http://drupal.org/node/1420008 Sublime Text: http://drupal.org/node/1419996 vim: http://drupal.org/node/1419996
This is still a draft!! Please cross check with http://drupal.org/coding-standards and http://drupal.org/project/coder if the validation is correct
Known Issues: Documentation Tags just rarly supported - there are many missing / disabled sniffs