jadu/twig-style

Jadu Twig coding style configuration for Twig-CS-Fixer

Maintainers

Details

github.com/jadu/twig-style

Source

Issues

Installs: 1 365

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 18

Forks: 0

Open Issues: 0

1.0.0 2024-02-19 17:20 UTC

Requires

Requires (Dev)

proprietary 968c7af1ac3ffa477eb8948fe52594173ce82515

This package is auto-updated.

Last update: 2024-04-20 09:08:48 UTC

README

Jadu Twig style is powered by Twig-CS-Fixer.

Installation

  1. Require the jadu/twig-style dev dependency:
composer require --dev jadu/twig-style
  1. Add the twig-cs-fixer config file .twig-cs-fixer.php:
<?php

use Jadu\Style\Twig\Standard\JaduStandard;
use TwigCsFixer\Config\Config;
use TwigCsFixer\File\Finder;
use TwigCsFixer\Ruleset\Ruleset;

$finder = Finder::create()
    ->in(__DIR__ . '/src')
    ->ignoreVCSIgnored(true);

$config = new Config();
$config->setFinder($finder);

$ruleset = new Ruleset();
$ruleset->addStandard(new JaduStandard());
$config->setRuleset($ruleset);

return $config;
  1. Add .twig-cs-fixer.cache to your project's .gitignore file.

Usage

Dry run

To lint your project's twig files, run the following dry run command:

vendor/bin/twig-cs-fixer lint

This command will return a list of twig-cs-fixer violations and is recommended for build tasks.

Fix

To fix any reported fixable violations, run the following fix command:

vendor/bin/twig-cs-fixer lint --fix

Jadu Twig Coding Standard Rules

This standard is based on the official Twig coding standards, with the following additions and changes:

Block spacing and new lines

There must be one new line before block tags and one new line after endblock tags.

{% block aside %}
    <div class="aside">

        {% block aside_inner %}

            {% block before_primary_supplements %}
            {% endblock %}

            {% block primary_supplements %}
            {% endblock %}

            {% block after_primary_supplements %}
            {% endblock %}

        {% endblock %}

    </div>
{% endblock %}

The following exceptions apply:

  • Inline blocks are allowed.

    <body class="{% block body_classes %}{{ bodyClasses }}{% endblock %}">

  • Comments on the line above block tags are allowed.

    {# This block adds a container around the aside #}
{% block aside_container %}

Endblock names

Any endblock tags must be followed by the name of the block they are closing.

{% block aside_container %}
{% endblock aside_container %}

No spaceless tags

The spaceless tag was deprecated in Twig 1.38 and 2.7.31 and an equivalent spaceless filter was introduced. Usages of the spaceless tag must be replaced with the equivalent apply spaceless filter.

{% apply spaceless %}
{% endapply %}

Punctuation spacing

A single space is required after the opening and before the closing of a hash.

{{ { 'foo': 'bar', 'baz': 'qux' } }}

The following exceptions apply:

  • Empty hashes must not contain any whitespace.
{% set emptyHash = {} %}

Variable names

Variable naming conventions are not enforced.

Development

The rules in the Jadu\Style\Twig\Rule\Development namespace are provided for development purposes to help with maintaining Jadu Twig style.

You will need to update your project's twig-cs-fixer config file .twig-cs-fixer.php to enable these rules, as non-fixable rules are disabled by default.

<?php

use Jadu\Style\Twig\Rule\Development\TokenTypeRule;
use TwigCsFixer\Config\Config;
use TwigCsFixer\File\Finder;
use TwigCsFixer\Ruleset\Ruleset;

$finder = Finder::create()
    ->in(__DIR__ . '/src')
    ->ignoreVCSIgnored(true);

$config = new Config();
$config->setFinder($finder);

$ruleset = new Ruleset();
$ruleset->addRule(new TokenTypeRule());
$config->setRuleset($ruleset);

$config->allowNonFixableRules();

return $config;
  • TokenTypeRule helps you see how a twig template is tokenized by Twig-CS-Fixer by mapping token types to values.

Footnotes

  1. https://symfony.com/blog/better-white-space-control-in-twig-templates#added-a-spaceless-filter ↩