wataridori/framgia-php-codesniffer

Framgia PHP Standards Checker by PHP CodeSniffer

0.3.0 2019-01-15 07:47 UTC

Requires

• squizlabs/php_codesniffer: ^3.0

MIT

• Tran Duc Thang

README

About

• PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
• Framgia PHP Standard is a set of coding conventions used by PHP team in Framgia Vietnam. It is based on the PSR-2 Coding Style Guide with some additional rules.
• This is the Coding Standard package for Code Sniffer to check whether your codes satisfy the Framgia Standard or not.
• New: This standard is compatible with both PHP CodeSniffer version 2 and 3. If you are using PHP CodeSniffer 2, please use the codes in 0.2 branch. If you are using PHP CodeSniffer 3, use the codes in master branch.

Install

Install locally

You can install in each project folder:

composer require --dev dealerdirect/phpcodesniffer-composer-installer
composer require --dev wataridori/framgia-php-codesniffer

phpcs command will be installed to folder vendor/bin.

Now you can check and run phpcs:

./vendor/bin/phpcs -i

./vendor/bin/phpcs --standard=Framgia /path/to/your/code

Install globally

• Install PHP_CodeSniffer globally by composer. Make sure you have ~/.composer/vendor/bin/ in your PATH.

composer global require "squizlabs/php_codesniffer=*"

• Clone this repository

// Version 2
cd ~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards
git clone -b 0.2 [e-mail]:wataridori/framgia-php-codesniffer.git FramgiaPHPCS

// Version 3
cd ~/.composer/vendor/squizlabs/php_codesniffer/src/Standards
git clone [e-mail]:wataridori/framgia-php-codesniffer.git FramgiaPHPCS

• Add its path to the PHP_CodeSniffer configuration:

phpcs --config-set installed_paths /path/to/FramgiaPHPCS

NOTE: If you want to set multiple installed_paths, you can get old paths by command:

phpcs --config-show installed_paths

Then you can set multiple paths by command:

phpcs --config-set installed_paths /absolute/path/1,/absolute/path/2,/yet/another/absolute/path/

• Check whether the Framgia Standard has been installed succesfully or not

phpcs -i

• Check your code using Framgia Standard

phpcs --standard=Framgia /path/to/your/code

• If you do not want to install this package inside CodeSniffer Standards folder, you can clone it to everywhere you want and specify the installed folder when you run phpcs command.

phpcs --standard=/path/to/your/framgia-php-codesniffer /path/to/your/code

• It's a pity that the default encoding used by PHP_CodeSniffer is ISO-8859-1. Yes, it is not UTF-8. Therefore, you will have some problems with the words counter if you use Japanese in your codes. You'd better change the default encoding to UTF-8.

phpcs --config-set encoding utf-8

Or set the encoding to UTF-8 when running the command.

phpcs --standard=Framgia /path/to/your/code --encoding=utf-8