blob: 8e1732e4ee9557a8d814431e0b9f957a334f0957 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# jinja
This rule can report problems related to jinja2 string templates. The current
version can report:
- `jinja[spacing]` when there are no spaces between variables
and operators, including filters, like `{{ var_name | filter }}`. This
improves readability and makes it less likely to introduce typos.
- `jinja[invalid]` when the jinja2 template is invalid, like `{{ {{ '1' }} }}`,
which would result in a runtime error if you try to use it with Ansible, even
if it does pass the Ansible syntax check.
As jinja2 syntax is closely following Python one we aim to follow
[black](https://black.readthedocs.io/en/stable/) formatting rules. If you are
curious how black would reformat a small sniped feel free to visit
[online black formatter](https://black.vercel.app/) site. Keep in mind to not
include the entire jinja2 template, so instead of `{{ 1+2==3 }}`, do paste
only `1+2==3`.
In ansible, `changed_when`, `failed_when`, `until`, `when` are considered to
use implicit jinja2 templating, meaning that they do not require `{{ }}`. Our
rule will suggest the removal of the braces for these fields.
## Problematic code
```yaml
---
- name: Some task
vars:
foo: "{{some|dict2items}}" # <-- jinja[spacing]
bar: "{{ & }}" # <-- jinja[invalid]
when: "{{ foo | bool }}" # <-- jinja[spacing] - 'when' has implicit templating
```
## Correct code
```yaml
---
- name: Some task
vars:
foo: "{{ some | dict2items }}"
bar: "{{ '&' }}"
when: foo | bool
```
## Current limitations
In its current form, this rule presents the following limitations:
- Jinja2 blocks that have newlines in them will not be reformatted because we
consider that the user deliberately wanted to format them in a particular way.
- Jinja2 blocks that use tilde as a binary operation are ignored because black
does not support tilde as a binary operator. Example: `{{ a ~ b }}`.
- Jinja2 blocks that use dot notation with numbers are ignored because python
and black do not allow it. Example: `{{ foo.0.bar }}`
|
