eviweb / fuelphp-phpcs
PHP Code Sniffer standard for Fuel PHP with dedicated CLI
Installs: 48 894
Dependents: 0
Suggesters: 0
Security: 0
Stars: 27
Watchers: 2
Forks: 12
Open Issues: 1
Requires
- php: >=5.3.3
- squizlabs/php_codesniffer: ~2
Requires (Dev)
- phpunit/phpunit: ^4 || ^5
README
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").
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)
- clone the project
git clone https://github.com/eviweb/fuelphp-phpcs.git - change directory to ./fuelphp-phpcs
cd fuelphp-phpcs - run installer with root privileges
sudo ./install.sh
Uninstall (Linux Only)
- change directory to ./fuelphp-phpcs
cd fuelphp-phpcs - 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 !
Requirements
Please note that this package works with PHP Code Sniffer version 2.9.x.