format: convert single-quoted string literals to double quotes

Author: claude

src/cfengine_cli/format.py

@@ -95,6 +95,23 @@ def text(node: Node) -> str:
     return node.text.decode("utf-8")
 
 
+def _normalize_quotes(literal: str) -> str:
+    """Normalize a CFEngine string literal to the preferred quote style.
+
+    Double quotes are the default. A single-quoted literal is rewritten with
+    double quotes unless its content contains a double-quote character, in
+    which case it is left single-quoted to avoid escaping. An escaped single
+    quote (\\') becomes a plain single quote when converting, since it needs
+    no escaping inside a double-quoted string.
+    """
+    if len(literal) < 2 or literal[0] != "'" or literal[-1] != "'":
+        return literal
+    inner = literal[1:-1]
+    if '"' in inner:
+        return literal
+    return '"' + inner.replace("\\'", "'") + '"'
+
+
 class Formatter:
     """Accumulates formatted output line-by-line into a string buffer."""
 
@@ -202,6 +219,8 @@ def stringify_single_line_nodes(nodes: list[Node]) -> str:
 
 def stringify_single_line_node(node: Node) -> str:
     """Recursively flatten a node and its children into a single-line string."""
+    if node.type == "quoted_string":
+        return _normalize_quotes(text(node))
     if not node.children:
         return text(node)
     return stringify_single_line_nodes(node.children)
@@ -462,7 +481,7 @@ def _promiser_text(children: list[Node]) -> str | None:
     promiser_node = next((c for c in children if c.type == "promiser"), None)
     if not promiser_node:
         return None
-    return text(promiser_node)
+    return _normalize_quotes(text(promiser_node))
 
 
 def _promiser_line_with_stakeholder(children: list[Node]) -> str | None:

tests/format/012_quotes.expected.cf

@@ -0,0 +1,15 @@
+# This demonstrates normalization of string literal quote styles:
+# single-quoted literals become double-quoted (the default) unless
+# their content contains a double-quote character.
+bundle agent main
+{
+  vars:
+    "a" string => "hello";
+    "b" string => "world";
+    "c" string => 'say "hi"';
+    "d" string => "it's here";
+    "e" slist => { "one", "two" };
+
+  reports:
+    "a single-quoted promiser";
+}

tests/format/012_quotes.input.cf

@@ -0,0 +1,15 @@
+# This demonstrates normalization of string literal quote styles:
+# single-quoted literals become double-quoted (the default) unless
+# their content contains a double-quote character.
+bundle agent main
+{
+vars:
+"a" string => 'hello';
+"b" string => "world";
+"c" string => 'say "hi"';
+"d" string => 'it\'s here';
+"e" slist => { 'one', 'two' };
+
+reports:
+'a single-quoted promiser';
+}

tests/unit/test_format.py

@@ -512,3 +512,43 @@ def test_format_line_length_respected():
     for line in result.strip().split("\n"):
         # Allow slight overshoot for long strings that can't be split
         assert len(line) <= 80, f"Line too long: {line!r}"
+
+
+def test_format_single_to_double_quotes():
+    code = "bundle agent main\n{\nvars:\n\"a\" string => 'hello';\n}"
+    result = _format(code)
+    assert '"a" string => "hello";' in result
+    assert "'hello'" not in result
+
+
+def test_format_keep_single_quotes_with_inner_double():
+    code = "bundle agent main\n{\nvars:\n\"a\" string => 'say \"hi\"';\n}"
+    result = _format(code)
+    assert "'say \"hi\"'" in result
+
+
+def test_format_double_quotes_unchanged():
+    code = 'bundle agent main\n{\nvars:\n"a" string => "world";\n}'
+    result = _format(code)
+    assert '"a" string => "world";' in result
+
+
+def test_format_escaped_single_quote_to_double():
+    code = "bundle agent main\n{\nvars:\n\"a\" string => 'it\\'s here';\n}"
+    result = _format(code)
+    assert '"a" string => "it\'s here";' in result
+
+
+def test_format_single_quotes_in_list():
+    code = "bundle agent main\n{\nvars:\n\"a\" slist => { 'one', 'two' };\n}"
+    result = _format(code)
+    assert '"one"' in result
+    assert '"two"' in result
+    assert "'one'" not in result
+
+
+def test_format_single_quoted_promiser_to_double():
+    code = "bundle agent main\n{\nreports:\n  'hello';\n}"
+    result = _format(code)
+    assert '"hello"' in result
+    assert "'hello'" not in result