m6web/coke

PHP Code Sniffer configurator

Coke - Enjoy sniffing your code

Coke is a Shell/Bash command using PHP Code Sniffer allowing rules management per project., _(*1)

Configuration file

Create a .coke file at your project root :, _(*2)

# Command used to launch PHP CodeSniffer (optional - default: phpcs)
command=phpcs

# Path used to load Standards (optional)
standard-path=path/to/PHPCS/Standards/

# Standard used by PHP CodeSniffer (required)
standard=Symfony2

# Verbose mode (optional - default: false)
verbose=true

# Only Git changed mode (optional - default: false)
only-git-changed=true

# White list of files and directories (optional)
src/
test.php

# Black list of files and directories (optional)
!Tests
!src/OldFile.php

and just launch the command :, _(*3)

$ coke

Run the command with arguments

You can override .coke settings by passing directly configuration as arguments to the command :, _(*4)

$ coke src test.php --standard=Symfony2 --ignore=Tests,src/OldFile.php -v

The order of arguments is not important, _(*5)

src test.php Files/Directories to include in the check
--standard=Symfony2 Standard to use for check
--ignore=Tests,src/OldFile.php URL patterns to ignore in the check
--only-git-changed Check only changed files
-v Use verbose mode, _(*6)

Additional arguments

You can use any phpcs arguments (documentation), _(*7)

For example if you want to generate a report with your favorite CI tools you can run, _(*8)

$ coke --report-checkstyle=checkstyle.xml

Installation via composer

Add coke in the require-dev section of your composer.json :, _(*9)

"require-dev": {
    "m6web/coke" : "~2.0"
}

By default composer will add a symlink to coke in vendor/bin/coke., _(*10)

If you want to change it, add this in your composer.json (more information about this in the composer documentation) :, _(*11)

"config": {
    "bin-dir": "bin"
}

Then you can call coke via :, _(*12)

./bin/coke

Git pre-commit hook

You can use a dedicated pre-commit hook :, _(*13)

$ wget --output-document=.git/hooks/pre-commit https://gist.githubusercontent.com/JJK801/5867810/raw/f26ec4778273b3f7140428252ab31951de2faba4/pre-commit.sh

Or, _(*14)

$ curl -L https://gist.githubusercontent.com/JJK801/5867810/raw/f26ec4778273b3f7140428252ab31951de2faba4/pre-commit.sh > .git/hooks/pre-commit

Then, _(*15)

$ chmod +x .git/hooks/pre-commit

Credits

Developped by the Cytron Team of M6 Web., _(*16)

License

Coke is licensed under the MIT license., _(*17)