From 2fe34b6444502079dc0b84365ce82dbc92de308e Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 13 Apr 2024 14:06:49 +0200
Subject: Adding upstream version 6.17.2.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 src/ansiblelint/rules/loop_var_prefix.md | 78 ++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 src/ansiblelint/rules/loop_var_prefix.md

(limited to 'src/ansiblelint/rules/loop_var_prefix.md')

diff --git a/src/ansiblelint/rules/loop_var_prefix.md b/src/ansiblelint/rules/loop_var_prefix.md
new file mode 100644
index 0000000..33adbd7
--- /dev/null
+++ b/src/ansiblelint/rules/loop_var_prefix.md
@@ -0,0 +1,78 @@
+# loop-var-prefix
+
+This rule avoids conflicts with nested looping tasks by configuring a variable
+prefix with `loop_var`. Ansible sets `item` as the loop variable. You can use
+`loop_var` to specify a prefix for loop variables and ensure they are unique to
+each task.
+
+This rule can produce the following messages:
+
+- `loop-var-prefix[missing]` - Replace any unsafe implicit `item` loop variable
+  by adding `loop_var: <loop_var_prefix>...`.
+- `loop-var-prefix[wrong]` - Ensure loop variables start with
+  `<loop_var_prefix>`.
+
+This rule originates from the [Naming parameters section of Ansible Best
+Practices guide][cop314].
+
+## Settings
+
+You can change the behavior of this rule by overriding its default regular
+expression used to check loop variable naming. Keep in mind that the `{role}`
+part is replaced with the inferred role name when applicable.
+
+```yaml
+# .ansible-lint
+loop_var_prefix: "^(__|{role}_)"
+```
+
+This is an opt-in rule. You must enable it in your Ansible-lint configuration as
+follows:
+
+```yaml
+enable_list:
+  - loop-var-prefix
+```
+
+## Problematic Code
+
+```yaml
+---
+- name: Example playbook
+  hosts: localhost
+  tasks:
+    - name: Does not set a prefix for loop variables.
+      ansible.builtin.debug:
+        var: item
+      loop:
+        - foo
+        - bar # <- These items do not have a unique prefix.
+    - name: Sets a prefix that is not unique.
+      ansible.builtin.debug:
+        var: zz_item
+      loop:
+        - foo
+        - bar
+      loop_control:
+        loop_var: zz_item # <- This prefix is not unique.
+```
+
+## Correct Code
+
+```yaml
+---
+- name: Example playbook
+  hosts: localhost
+  tasks:
+    - name: Sets a unique prefix for loop variables.
+      ansible.builtin.debug:
+        var: zz_item
+      loop:
+        - foo
+        - bar
+      loop_control:
+        loop_var: my_prefix # <- Specifies a unique prefix for loop variables.
+```
+
+[cop314]:
+  https://redhat-cop.github.io/automation-good-practices/#_naming_parameters
-- 
cgit v1.2.3