README

PHP CS Fixer配置文件，用于健康足部组件

它基于refinery29/php-cs-fixer-config的思路。

安装

运行

$ composer require --dev plhw/php-cs-fixer-config:^2.8.1

添加到composer.json；

"scripts": {
  "check": [
    "@cs",
  ],
  "cs": "php-cs-fixer fix -v --diff --dry-run",
  "cs-fix": "php-cs-fixer fix -v --diff",
}

使用

配置

在项目的根目录下创建一个配置文件.php_cs

<?php

$config = new HF\CS\Config();
$config->getFinder()->in(__DIR__);
$config->getFinder()->append(['.php_cs']);

$cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__;

$config->setCacheFile($cacheDir . '/.php_cs.cache');

return $config;

Git

将.php_cs.cache（这是由php-cs-fixer创建的缓存文件）添加到.gitignore

vendor/
.php_cs.cache

Travis

更新你的.travis.yml以缓存php_cs.cache文件

cache:
  directories:
    - $HOME/.php-cs-fixer

然后在script部分运行php-cs-fixer

script:
  - composer cs

GitLab

更新你的.gitlab-ci以缓存php_cs.cache文件

  script:
  - composer cs

修复问题

手动

如果您需要本地修复问题，只需运行

$ . composer cs-fix

提交前钩子

您可以添加一个pre-commit钩子

$ touch .git/pre-commit && chmod +x .git/pre-commit

将以下内容粘贴到.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.8.1"
    echo ""
fi

cd $CURRENT_DIRECTORY;
echo "pre commit hook finish"

许可证

此包使用MIT许可证授权。