PHP Code Sniffer standard for Fuel PHP
PHP Shell
Latest commit f554659 Nov 18, 2016 @eviweb bump version number
Signed-off-by: Eric Villard <dev@eviweb.fr>

README.md

PHP_CodeSniffer Fuel PHP Standard

PHP Code Sniffer rules that cover a large part of the [Fuel PHP coding standards] (http://docs.fuelphp.com/general/coding_standards.html "Fuel PHP Coding Standards").

Build Status

How to install

The composer way (since v1.0.4)

run composer require --dev eviweb/fuelphp-phpcs:~1 in your fuelphp project.
It will automatically install PHP CodeSniffer using composer.

The old way

Install (Linux Only)

  1. clone the project git clone https://github.com/eviweb/fuelphp-phpcs.git
  2. change directory to ./fuelphp-phpcs cd fuelphp-phpcs
  3. run installer with root privileges sudo ./install.sh

Uninstall (Linux Only)

  1. change directory to ./fuelphp-phpcs cd fuelphp-phpcs
  2. run uninstaller with root privileges sudo ./uninstall.sh

How to use

Using the fuelphpcs command (since v1.0.4)

Assuming FuelPHPCS was installed inside ./fuel/vendor using composer and the bin-dir is ./fuel/vendor/bin.
Run ./fuel/vendor/bin/fuelphpcs PROJECT_TO_SNIFF_DIRECTORY where PROJECT_TO_SNIFF_DIRECTORY is your fuel php project directory.

The old way

run phpcs --standard=FuelPHP PROJECT_TO_SNIFF_DIRECTORY where PROJECT_TO_SNIFF_DIRECTORY is your fuel php project directory.

BE AWARE not to use --tab-width phpcs option with another value than 0, this would disable tabs recognition !