acalvino4/craft-twig-ruleset

为Craft社区提供的twig编码风格规则集

维护者

详细信息

github.com/acalvino4/craft-twigruleset

主页

源代码

问题

安装: 23

依赖: 1

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

1.0.3 2023-05-04 19:22 UTC

Requires

Requires (Dev)

MIT c7d5ded6dfeab325185b5e211459b9e9df392921

This package is auto-updated.

Last update: 2024-09-04 22:11:23 UTC

README

为了尽可能自动化风格检查，理想情况下，在Craft CMS项目中不应遗漏twig文件。

有这样一个优秀的包，但它在一两个点上忽略了Craft约定。

  • 驼峰式变量名，而不是蛇形命名
  • 使用Andrew Welch广泛使用的空合并运算符

此处提供的规则集在上述两个问题之外保持了官方规则集，如果可以证明这些修改对Craft社区是必要的，我将乐意考虑进一步的修改请求/PR。

使用方法

安装

composer require --dev acalvino4/craft-twig-ruleset

配置

<?php

// .twig_cs.php in project root

declare(strict_types=1);

use acalvino4\crafttwigruleset\CraftRuleset;
use FriendsOfTwig\Twigcs\Config\Config;
use FriendsOfTwig\Twigcs\Finder\TemplateFinder;

return Config::create()
    ->addFinder(TemplateFinder::create()->in('templates'))
    ->setRuleSet(CraftRuleset::class)
;

此配置格式直接来自twigcs，因此那里提到的任何自定义或替代文件名都将正常工作。这里唯一独特的是使用CraftRuleset。

运行

./vendor/bin/twigcs

或者，添加一个调用twigcs的composer脚本，或者使用IDE扩展，如Twigcs Linter。