airmedia / php-cs-fixer-config
PHP-CS-Fixer config for Airmedia's projects
0.7.0
2019-01-09 12:20 UTC
Requires
- php: ^7.1
- friendsofphp/php-cs-fixer: ^2.14
Requires (Dev)
- phpunit/phpunit: ^5.7
README
PHP-CS-Fixer config for Airmedia's projects.
It's based on the ideas of refinery29/php-cs-fixer-config
.
Installation
$ composer require airmedia/php-cs-fixer-config --dev
Usage
Configuration
Create a configuration file .php_cs
in the root of your project:
<?php $config = new AirMedia\CS\Config(); $config->getFinder()->in(__DIR__); $cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__; $config->setCacheFile($cacheDir . '/.php_cs.cache'); return $config;
Git
Add .php_cs.cache
(this is the cache file created by php-cs-fixer
) to .gitignore
:
vendor/
.php_cs.cache
Fixing issues
Manually
If you need to fix issues locally, just run
$ ./vendor/bin/php-cs-fixer fix -v
Pre-commit hook
You can add a pre-commit
hook
$ touch .git/pre-commit && chmod +x .git/pre-commit
Paste this into .git/pre-commit
:
#!/usr/bin/env bash echo "pre commit hook start" CURRENT_DIRECTORY=`pwd` GIT_HOOKS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" PROJECT_DIRECTORY="$GIT_HOOKS_DIR/../.." cd $PROJECT_DIRECTORY; PHP_CS_FIXER="vendor/bin/php-cs-fixer" HAS_PHP_CS_FIXER=false if [ -x "$PHP_CS_FIXER" ]; then HAS_PHP_CS_FIXER=true fi if $HAS_PHP_CS_FIXER; then git status --porcelain | grep -e '^[AM]\(.*\).php$' | cut -c 3- | while read line; do ${PHP_CS_FIXER} fix --config-file=.php_cs --verbose ${line}; git add "$line"; done else echo "" echo "Please install php-cs-fixer, e.g.:" echo "" echo " composer require friendsofphp/php-cs-fixer:2.0.0" echo "" fi cd $CURRENT_DIRECTORY; echo "pre commit hook finish"
License
This package is licensed using the MIT License.