vaclavvanik / coding-standard

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Václav Vaník Coding Standard

The Václav Vaník Coding Standard VVCS is a set of PHP_CodeSniffer rules applied to my projects.

VVCS is inspired by Doctrine Coding Standard and heavily based on Slevomat Coding Standard.

Installation

The recommended way to install PHP CS Fixer is to use Composer in a dedicated composer.json file in your project, for example in the tools/php-coding-standard directory:

mkdir --parents tools/php-coding-standard
composer require --working-dir=tools/php-coding-standard vaclavvanik/coding-standard
cp tools/php-coding-standard/vendor/vaclavvanik/coding-standard/phpcs.dist.xml tools/php-coding-standard/.phpcs.xml
cp tools/php-coding-standard/vendor/vaclavvanik/coding-standard/.gitignore tools/php-coding-standard/.gitignore

Configuration

Dist configuration file: phpcs.dist.xml.

Ruleset documentation.

Usage

Fix:

./tools/php-coding-standard/vendor/bin/phpcbf --basepath=. --standard=tools/php-coding-standard/.phpcs.xml

Check:

./tools/php-coding-standard/vendor/bin/phpcs --basepath=. --standard=tools/php-coding-standard/.phpcs.xml

About

License:BSD 3-Clause "New" or "Revised" License