Limit sequence-of-sequence indents to a single space (#3671)

Co-authored-by: Sorin Sbarnea <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

.config/dictionary.txt

@@ -160,6 +160,7 @@ hwcksum
 idempotency
 ignorelist
 importlib
+indentless
 iniconfig
 inlinehilite
 insertafter

.github/workflows/tox.yml

@@ -71,7 +71,7 @@ jobs:
       WSLENV: FORCE_COLOR:PYTEST_REQPASS:TOXENV:GITHUB_STEP_SUMMARY
       # Number of expected test passes, safety measure for accidental skip of
       # tests. Update value if you add/remove tests.
-      PYTEST_REQPASS: 817
+      PYTEST_REQPASS: 818
     steps:
       - name: Activate WSL1
         if: "contains(matrix.shell, 'wsl')"

.gitignore

@@ -54,6 +54,8 @@ src/ansiblelint/_version.py
 test/fixtures/formatting-before/
 # prettier should not edit this due to forcibly extra-long lines
 examples/playbooks/vars/strings.transformed.yml
+# prettier should not edit this due to intentionally spaced nesting
+examples/playbooks/vars/transform_nested_data.yml
 
 # other
 .cache

examples/playbooks/vars/transform_nested_data.transformed.yml

@@ -0,0 +1,7 @@
+---
+sequence:
+  - - - 111
+      - 112
+    - 12
+  - - 21
+    - - 221

examples/playbooks/vars/transform_nested_data.yml

@@ -0,0 +1,7 @@
+---
+sequence:
+  -    -    - 111
+            - 112
+       - 12
+  -    - 21
+       -    - 221

pyproject.toml

@@ -240,6 +240,7 @@ ignore = [
   "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
   "TRY",
   "PERF203",
+  "PD011", # We are not using pandas, any .values attributes are unrelated
 ]
 select = ["ALL"]
 target-version = "py39"

src/ansiblelint/yaml_utils.py

@@ -599,6 +599,17 @@ def choose_scalar_style(self) -> Any:
             return "'"
         return self.preferred_quote
 
+    def increase_indent(
+        self,
+        flow: bool = False,  # noqa: FBT002
+        sequence: bool | None = None,
+        indentless: bool = False,  # noqa: FBT002
+    ) -> None:
+        super().increase_indent(flow, sequence, indentless)
+        # If our previous node was a sequence and we are still trying to indent, don't
+        if self.indents.last_seq():
+            self.indent = self.column + 1
+
     def write_indicator(
         self,
         indicator: str,  # ruamel.yaml typehint is wrong. This is a string.
@@ -621,6 +632,9 @@ def write_indicator(
             and not self._in_empty_flow_map
         ):
             indicator = (" " * spaces_inside) + "}"
+        # Indicator sometimes comes with embedded spaces we need to squish
+        if indicator == "  -" and self.indents.last_seq():
+            indicator = "-"
         super().write_indicator(indicator, need_whitespace, whitespace, indention)
         # if it is the start of a flow mapping, and it's not time
         # to wrap the lines, insert a space.

test/test_transformer.py

@@ -114,6 +114,12 @@ def fixture_runner_result(
             True,
             id="jinja_spacing",
         ),
+        pytest.param(
+            "examples/playbooks/vars/transform_nested_data.yml",
+            3,
+            True,
+            id="nested",
+        ),
     ),
 )
 def test_transformer(  # pylint: disable=too-many-arguments, too-many-locals