vincentlanglet/twig-cs-fixer

自动修复 Twig 代码格式的工具

资助包维护!
VincentLanglet

安装量: 1,757,012

依赖者: 17

建议者: 1

安全: 0

星标: 216

关注者: 7

分支: 21

公开问题: 2

类型:编码规范

3.1.0 2024-08-30 11:23 UTC

README

PHP Version Latest Stable Version License Actions Status Coverage Type Coverage Infection MSI

安装

通过 Composer

此工具可以通过 Composer 安装。

将包添加为项目的依赖项

composer require --dev vincentlanglet/twig-cs-fixer

然后,使用它!

vendor/bin/twig-cs-fixer lint /path/to/code
vendor/bin/twig-cs-fixer lint --fix /path/to/code

注意

尽管 bin 依赖项可能存在 composer 冲突,但这是推荐的方法,因为它会自动加载你需要的所有内容。

作为 PHAR

您可以通过以下链接获取所需的 VERSION 的稳定版本的 Phar 存档

wget -c https://github.com/VincentLanglet/Twig-CS-Fixer/releases/download/VERSION/twig-cs-fixer.phar

PHAR 文件使用公钥签名,可以通过 keys.openpgp.org 使用 id AC0E7FD8858D80003AA88FF8DEBB71EDE9601234 查询。

提示

您肯定需要在您的 配置文件 中添加以下内容

require_once __DIR__.'/vendor/autoload.php';

以便

Twig 编码规范规则

来自 官方文档

分隔符间距

确保在分隔符开头({{{%{#)后有一个空格,在分隔符结尾(}}%}#})前有一个空格。

当使用空白控制字符时,不要在它和分隔符之间放置任何空格。

运算符间距

确保在以下运算符前后有一个空格:比较运算符(==!=<>>=<=)、数学运算符(+-/*%//**)、逻辑运算符(notandor)、~isin 和三元运算符(?:)。

移除 .. 运算符前后的任何空格。

标点符号间距

确保在散列中的 : 后和数组及散列中的 , 后有一个空格。

在表达式中的开括号和闭括号之间移除任何空格。

移除以下运算符前后的任何空格:|.[]

在过滤器和函数调用中移除括号前后的任何空格。

移除数组和解列开头的括号和结尾的括号前后的任何空格。

自定义配置

默认情况下,twig-cs-fixer 规范已启用,包括 twig 编码规范规则和一些额外规则。此工具还提供仅包含 twig 规则的标准以及包含来自 symfony 编码规范的额外规则的标准。

一切都可以配置,因此请参阅以下文档