https://github.com/jadu/twig-style

twig-cs-fixer configuration for Jadu code
https://github.com/jadu/twig-style

Last synced: 5 days ago
JSON representation

twig-cs-fixer configuration for Jadu code

• Host: GitHub
• URL: https://github.com/jadu/twig-style
• Owner: jadu
• Created: 2023-10-06T15:59:56.000Z (about 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-11-01T16:59:59.000Z (17 days ago)
• Last Synced: 2024-11-01T17:29:45.878Z (17 days ago)
• Language: PHP
• Size: 31.3 KB
• Stars: 0
• Watchers: 18
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Jadu Twig Style

Jadu Twig style is powered by [Twig-CS-Fixer](https://github.com/VincentLanglet/Twig-CS-Fixer).

## Installation

1. Require the jadu/twig-style dev dependency:

```sh

composer require --dev jadu/twig-style

```

2. Add the twig-cs-fixer config file `.twig-cs-fixer.php`:

```php

in(__DIR__ . '/src')

    ->ignoreVCSIgnored(true);

$config = new Config();

$config->setFinder($finder);

$ruleset = new Ruleset();

$ruleset->addStandard(new JaduStandard());

$config->setRuleset($ruleset);

return $config;

```

3. 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:

```sh

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:

```sh

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

```

## Jadu Twig Coding Standard Rules

This standard is based on the [official Twig coding standards](https://twig.symfony.com/doc/3.x/coding_standards.html), 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.

```twig

{% block aside %}

    


        {% block aside_inner %}

            {% block before_primary_supplements %}

            {% endblock %}

            {% block primary_supplements %}

            {% endblock %}

            {% block after_primary_supplements %}

            {% endblock %}

        {% endblock %}

    

{% endblock %}


```

The following exceptions apply:

- Inline blocks are allowed.

    ```twig

    

    ```

- Comments on the line above block tags are allowed.

    ```twig

    {# 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.

```twig

{% block aside_container %}

{% endblock aside_container %}

```

### No spaceless tags

The `spaceless` tag was deprecated in Twig 1.38 and 2.7.3[^1] and an equivalent `spaceless` filter was introduced. Usages of the `spaceless` tag must be replaced with the equivalent `apply spaceless` filter.

```twig

{% apply spaceless %}

{% endapply %}

```

### No filter tags

The `filter` tag was deprecated in Twig 1.40[^2] and 2.9[^3] in favour of the `apply` tag, which behaves identically to `filter` except that the wrapped template data is not scoped. Usages of the `filter` tag must be replaced with the equivalent `apply` tag.

```twig

{% apply lower|escape('html') %}

    UPPERCASE TEXT

{% endapply %}

{# outputs "<strong>uppercase text</strong>" #}

```

### Punctuation spacing

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

```twig

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

```

The following exceptions apply:

- Empty hashes must not contain any whitespace.

```twig

{% 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

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.

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

[^2]: https://twig.symfony.com/doc/1.x/tags/filter.html

[^3]: https://twig.symfony.com/doc/2.x/tags/filter.html