README

此存储库提供文档和工具，以帮助遵守我们的代码标准。

代码标准

我们主要遵循 Symfony 代码风格，但每个项目都可以定义自己的规则。比具体规则更重要的是，每个人都应一致地应用它们。这正是此存储库旨在帮助解决的问题。

要将此作为项目的开发依赖项安装，请添加以下内容

composer require --dev treehouselabs/standards

复制分发的 .php_cs 文件，根据需要修改

cp vendor/treehouselabs/standards/.php_cs .

注意：请确保 .php_cs.cache 在 .gitignore 中！

vendor/
.php_cs.cache
composer.lock

当修复程序作为 Travis 脚本运行时，如果存在 CS 违规，构建将失败。请将以下内容添加到 .travis.yml

script:
  - bin/php-cs-fixer fix --config=.php_cs --verbose --diff --dry-run

为了提高性能，请确保缓存修复程序的缓存目录

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

有多种方法可以将 CS 集成到您的工作流程中。以下是我们在使用的方法

这不是最简单的方法，但如果适合您，可以采用代码风格，并这样编写。无需修复！

在提交之前，手动运行修复程序

./bin/php-cs-fixer fix -v

这也可以使用您选择的编辑器的插件来完成。

存储库附带一个 git 预提交钩子，可以在提交之前自动修复您的代码。但是请注意，这可能会在没有您看到的情况下修改代码。

cp vendor/treehouselabs/standards/hooks/pre-commit .git/pre-commit
chmod +x .git/pre-commit

当然，如果您更喜欢其他方法，那也很好。无论哪种方法都行。再次强调，重要的是要一致地应用。