README

缺少 twig 的 checkstyle！

Twigcs 的目标是成为 phpcs 对 php 的作用。它检查你的代码库中编码标准的违规情况。

请注意，该项目仍处于早期开发阶段，可能会发生重大变化。

如何安装

composer global require allocine/twigcs

基本上，只需运行

twigcs /path/to/views

在 Symfony 项目中，你可以运行，例如

twigcs /project/dir/app/Resources/views

你将在控制台中获得违规的摘要。命令的退出代码基于任何违规的严重性。默认情况下，twigcs 甚至不能容忍警告，这可以在运行时更改

twigcs /path/to/views --severity warning # Allow notices

在上面的示例中，警告仍然显示，但不会改变退出代码。

Twigcs 可以与您喜欢的 CI 服务器一起使用。命令本身将返回一致的退出代码，以告诉 CI 作业是否失败或成功。您还可以获得一个漂亮的 xml 报告（checkstyle 格式）

twigcs /path/to/views --reporter checkstyle > /path/to/report.xml

目前唯一可用的标准是 twig 的官方标准。

你可以创建一个实现 RulesetInterface 的类，并将其作为 --ruleset 选项提供给 CLI 脚本

twigcs /path/to/views --ruleset \MyApp\TwigCsRuleset

注意： twigcs 必须通过 composer 使用，并且规则集类必须可通过 composer 的自动加载器访问，才能使用此功能。

主分支是开发分支，如果在样式检查过程中发现任何错误或误报，请打开一个问题或提交一个拉取请求。

在创建或更改类时，不要忘记在文件顶部添加 @author。