You are here

Home » API reference » Coder 7.2

README.txt in Coder 7.2

Same filename in this branch
  1. 7.2 README.txt
  2. 7.2 coder_sniffer/README.txt
  3. 7.2 coder_upgrade/README.txt
  4. 7.2 scripts/coder_format/README.txt
  5. 7.2 scripts/coder_format/tests/README.txt
-------------------------------------------------------------------------------
                            Drupal Code Sniffer
-------------------------------------------------------------------------------

Drupal Code Sniffer is a coding standard validation tool for Drupal and contributed
modules/themes.

Online documentation: https://drupal.org/node/1419980


Installation: PEAR
------------------

Requirements:
  - PEAR
  - PHPCS 1.4.1 or newer

- 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:

$> sudo ln -sv /path/to/coder/coder_sniffer/Drupal $(pear config-get php_dir)/PHP/CodeSniffer/Standards

Please see the online documentation for more detailed instructions:

  https://drupal.org/node/1419988


Installation: Drush
-------------------

While Coder Sniffer 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 Coder 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


Installation: Composer
----------------------

You can also use Coder Sniffer as a library with Composer:

    "require": {
        "drupal/coder": "*"
    }

"composer install" will fetch all necessary dependencies and you can then use/execute
PHPCS locally in your project:

./vendor/bin/phpcs --standard=coder_sniffer/Drupal /path/to/code/to/review


Usage (running in a shell)
--------------------------

$> phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme /path/to/drupal_module

Usage (drush)
-------------

$> drush drupalcs sites/all/modules/custom

Working with Editors
--------------------
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


Attention
---------
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

File

coder_sniffer/README.txt
View source 
  1. -------------------------------------------------------------------------------

  2.                             Drupal Code Sniffer

  3. -------------------------------------------------------------------------------

  4. 

  5. Drupal Code Sniffer is a coding standard validation tool for Drupal and contributed

  6. modules/themes.

  7. 

  8. Online documentation: https://drupal.org/node/1419980

  9. 

  10. 

  11. Installation: PEAR

  12. ------------------

  13. 

  14. Requirements:

  15.   - PEAR

  16.   - PHPCS 1.4.1 or newer

  17. 

  18. - Install PEAR  ( http://pear.php.net/manual/en/installation.php )

  19. - Install PHPCS ( http://pear.php.net/package/PHP_CodeSniffer )

  20. - Sym-link the drupalcs directory into the standards folder for PHP_CodeSniffer.

  21.   The code for that looks like this:

  22. 

  23. $> sudo ln -sv /path/to/coder/coder_sniffer/Drupal $(pear config-get php_dir)/PHP/CodeSniffer/Standards

  24. 

  25. Please see the online documentation for more detailed instructions:

  26. 

  27.   https://drupal.org/node/1419988

  28. 

  29. 

  30. Installation: Drush

  31. -------------------

  32. 

  33. While Coder Sniffer can be used as a standalone set of rules for PHP_CodeSniffer,

  34. drush command support is included to facilitate ease of use, installation,

  35. and leveraging of drush features such as site aliasing.

  36. 

  37. Extract the contents of the Coder project into one of the locations specified

  38. in the drush README.txt COMMANDS section, such as the subdirectory of the

  39. .drush folder in your home directory.  For other alternatives, please see

  40. http://drupal.org/node/1419988

  41. 

  42. 

  43. Installation: Composer

  44. ----------------------

  45. 

  46. You can also use Coder Sniffer as a library with Composer:

  47. 

  48.     "require": {

  49.         "drupal/coder": "*"

  50.     }

  51. 

  52. "composer install" will fetch all necessary dependencies and you can then use/execute

  53. PHPCS locally in your project:

  54. 

  55. ./vendor/bin/phpcs --standard=coder_sniffer/Drupal /path/to/code/to/review

  56. 

  57. 

  58. Usage (running in a shell)

  59. --------------------------

  60. 

  61. $> phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme /path/to/drupal_module

  62. 

  63. Usage (drush)

  64. -------------

  65. 

  66. $> drush drupalcs sites/all/modules/custom

  67. 

  68. Working with Editors

  69. --------------------

  70. Drupal Code Sniffer can be used with various editors.

  71. 

  72. Editors:

  73. 

  74. eclipse: http://drupal.org/node/1420004

  75. Komodo: http://drupal.org/node/1419996

  76. Netbeans: http://drupal.org/node/1420008

  77. Sublime Text: http://drupal.org/node/1419996

  78. vim: http://drupal.org/node/1419996

  79. 

  80. 

  81. Attention

  82. ---------

  83. This is still a draft!!

  84. Please cross check with http://drupal.org/coding-standards and

  85. http://drupal.org/project/coder if the validation is correct

  86. 

  87. Known Issues:

  88. Documentation Tags just rarly supported - there are many missing / disabled sniffs