Mago's Twig linter ships 25 rules across 8 categories. Click any rule to expand its description, requirements, default configuration, and examples. Rule codes start with twig-; the configuration keys under [twig.linter.rules] leave that prefix out.

Clarity

Rules that make intent explicit and reduce reader effort. They flag patterns that are technically valid but obscure what the code is doing.

twig-no-nested-ternarywarning

Reports conditional expressions nested inside other conditional expressions. Split them into named values or branches.

Parentheses do not hide a nested conditional. A conditional in an arrow function body is not nested in the conditional around the arrow function.


Avoid
{{ flag ? (other ? one : two) : no }}
Prefer
{{ flag ? yes : no }}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"

Best practices

Idiomatic Twig patterns that the Twig documentation and coding standard recommend.

twig-prefer-include-functionwarning

Prefers the include() function to the include tag.

No fix is offered: a rewrite must account for escaping, sandboxing, scope, and call order.


Avoid
{% include 'card.twig' %}
Prefer
{{ include('card.twig') }}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"

Consistency

Stylistic uniformity across a codebase. Pick one way to do a thing, these rules help everyone stick to it.

twig-macro-argument-namewarning

Enforces snake_case for macro parameter names.

Non-ASCII names are left alone. No fix is offered, because renaming a parameter breaks calls that pass it by name.


Avoid
{% macro input(className) %}{% endmacro %}
Prefer
{% macro input(class_name) %}{% endmacro %}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
twig-macro-namewarning

Enforces snake_case for macro names.

Non-ASCII names are left alone. No fix is offered, because renaming a macro breaks its callers.


Avoid
{% macro htmlInput() %}{% endmacro %}
Prefer
{% macro html_input() %}{% endmacro %}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
twig-named-argument-namewarning

Enforces snake_case for named arguments.

Enable this only when the functions, filters, and macros you call follow the Twig coding standard. Non-ASCII names are left alone.


Avoid
{{ input(className: 'input') }}
Prefer
{{ input(class_name: 'input') }}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
twig-variable-namewarning

Enforces snake_case for the names that set, for, import, from, arrow functions, assignments, and destructuring bind.

Variables from the application, mapping keys, attribute names, and non-ASCII names are left alone.


Avoid
{% set firstName = user.name %}
Prefer
{% set first_name = user.name %}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
twig-end-block-namehelp

Requires the block or macro name on endblock and endmacro tags.

Short blocks need no closing tag. The fix adds the name and leaves whitespace control intact.


Avoid
{% block title %}Title{% endblock %}
Prefer
{% block title %}Title{% endblock title %}

OptionTypeDefault
enabledbooleanfalse
levelstring"help"
twig-named-argument-separatorhelp

Requires : between a named argument and its value, as the Twig coding standard recommends, instead of =.

Macro parameter defaults keep =.

This rule needs the minimum Twig version, [twig.linter] version, to be 3.12 or newer.

Avoid
{{ range(low = 1, high = 3) }}
Prefer
{{ range(low: 1, high: 3) }}

OptionTypeDefault
enabledbooleantrue
levelstring"help"
twig-single-quoteshelp

Prefers single quotes for plain strings: strings without escapes, apostrophes, #, or line breaks.

Other strings stay unchanged, because new quotes would change their meaning.


Avoid
{{ "title" }}
Prefer
{{ 'title' }}

OptionTypeDefault
enabledbooleanfalse
levelstring"help"

Deprecation

Twig features deprecated upstream that a later Twig release removes. Migrate before they break.

twig-deprecated-attributewarning

Reports calls to the built-in attribute() function, deprecated since Twig 3.15.

Use dynamic attribute access, object.(name), after checking its call and lookup behavior. A macro imported as attribute is left alone.

This rule needs the minimum Twig version, [twig.linter] version, to be 3.15 or newer.

Avoid
{{ attribute(object, name) }}
Prefer
{{ object.(name) }}

OptionTypeDefault
enabledbooleantrue
levelstring"warning"
twig-deprecated-spacelesswarning

Reports the spaceless filter, deprecated since Twig 3.12, including in apply tags.

No fix is offered: check the rendered output before you stop stripping whitespace.

This rule needs the minimum Twig version, [twig.linter] version, to be 3.12 or newer.

Avoid
{{ text|spaceless }}
Prefer
{{ text }}

OptionTypeDefault
enabledbooleantrue
levelstring"warning"
twig-duplicate-macrowarning

Reports macro names repeated in one template. Names are case-sensitive.

Twig 3 uses the last definition; Twig 3.29 deprecates this and Twig 4 rejects it. An embed body has its own macros.

This rule needs the minimum Twig version, [twig.linter] version, to be 3.29 or newer.

Avoid
{% macro title() %}A{% endmacro %}
{% macro title() %}B{% endmacro %}
Prefer
{% macro title() %}Title{% endmacro %}

OptionTypeDefault
enabledbooleantrue
levelstring"warning"

Maintainability

Code that is hard to keep alive over time, too complex, too tangled, too fragile. These rules surface the cost early.

twig-explicit-include-contextwarning

Requires only on include and embed tags, and a literal with_context: false in calls to the built-in include() function, so templates do not share the whole context by accident.

A macro imported as include is left alone. No fix is offered, because it would change the variables the included template can see.


Avoid
{% include 'card.twig' %}
Prefer
{% include 'card.twig' with {title: title} only %}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
twig-no-include-ignore-missingwarning

Disallows ignore missing on include and embed tags, and a literal ignore_missing: true in calls to the built-in include() function.

Dynamic values are left alone.


Avoid
{% include 'card.twig' ignore missing %}
Prefer
{% include 'card.twig' %}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"

Redundancy

Dead code, unused values, and constructs that have no observable effect. Trimming them keeps the codebase honest.

twig-constant-conditionwarning

Reports literal boolean conditions in if branches and conditional expressions.

The rule does not guess the truthiness of other values. No fix is offered, because removing a branch removes rendered text.


Avoid
{% if true %}yes{% endif %}
Prefer
{% if flag %}yes{% endif %}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"

Security

Output that bypasses escaping, debug output that exposes the template context, and functions, filters, or tags your project bans.

twig-disallowed-filterswarning

Reports the filters listed in names, including in apply tags.

Names match exactly. An empty list reports nothing.


Avoid
{{ title|raw }}
Prefer
{{ title }}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
namesarray[]
twig-disallowed-functionswarning

Reports calls to the functions listed in names.

Names match exactly, including macros imported under those names. An empty list reports nothing.


Avoid
{{ source('secret.txt') }}
Prefer
{{ title }}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
namesarray[]
twig-disallowed-tagswarning

Reports the tags listed in names, including custom tags.

Names match exactly. An empty list reports nothing.


Avoid
{% flush %}
Prefer
{{ title }}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
namesarray[]
twig-no-autoescape-falsewarning

Disallows autoescape false blocks, which turn off escaping for their whole body.

No fix is offered, because Mago cannot tell which output needs escaping.


Avoid
{% autoescape false %}{{ value }}{% endautoescape %}
Prefer
{% autoescape 'html' %}{{ value }}{% endautoescape %}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"
twig-no-dumpwarning

Reports calls to the built-in dump() function. Debug output can expose the template context.

A macro imported as dump is left alone. No fix is offered: the calls and their arguments stay in place.


Avoid
{{ dump(user) }}
Prefer
{{ user.name }}

OptionTypeDefault
enabledbooleantrue
levelstring"warning"
twig-no-rawwarning

Disallows the raw filter, including in apply tags. Raw output can be deliberate, so this rule is off by default.

No fix is offered, because removing the filter can change escaping or token boundaries.


Avoid
{{ user.name|raw }}
Prefer
{{ user.name }}

OptionTypeDefault
enabledbooleanfalse
levelstring"warning"

Correctness

Bugs and logic errors. Rules in this category catch code that does something the author probably did not intend.

twig-duplicate-blockerror

Reports block names repeated in one template. Twig rejects such templates.

An embed body has its own blocks, so it may reuse a name from the enclosing template.


Avoid
{% block title %}A{% endblock %}
{% block title %}B{% endblock %}
Prefer
{% block title %}Title{% endblock %}

OptionTypeDefault
enabledbooleantrue
levelstring"error"
twig-duplicate-parametererror

Reports macro parameter names that repeat an earlier parameter, including variadic parameters. Twig rejects such macros.


Avoid
{% macro input(name, name) %}{% endmacro %}
Prefer
{% macro input(name, value) %}{% endmacro %}

OptionTypeDefault
enabledbooleantrue
levelstring"error"
twig-duplicate-argumentwarning

Reports named arguments that repeat a name in one call, filter, or test.

Twig ignores underscores and case in the argument names of its own functions, filters, and tests, so first_name and firstName name the same argument there. Calls to macros and methods compare names exactly.


Avoid
{{ range(low: 1, low: 3) }}
Prefer
{{ range(low: 1, high: 3) }}

OptionTypeDefault
enabledbooleantrue
levelstring"warning"
twig-duplicate-keywarning

Reports literal mapping keys that repeat an earlier key after PHP's array-key conversion, so '1' and 1 are the same key. The last value replaces the first.

Dynamic keys are left alone. No fix is offered, because both values can have side effects.


Avoid
{{ {title: title, title: body} }}
Prefer
{{ {title: title, body: body} }}

OptionTypeDefault
enabledbooleantrue
levelstring"warning"

↳ Edit this page →