Fix for parsing cgx files without template nodes (#4)

* Fix for parsing cgx files without template nodes
* Add some whitespace within a root nodes' children

Author: berendkleinhaneveld

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ruff-cgx"
-version = "0.1.1"
+version = "0.1.2"
 description = "Ruff linter and formatter for collagraph single-file components"
 readme = "README.md"
 requires-python = ">=3.10"

ruff_cgx/formatter.py

@@ -12,6 +12,9 @@
 
 
 def format_script(path, script_node, source_lines, check):
+    """
+    Returns formatted source and the original location of the node
+    """
     start, end = script_node.location[0], script_node.end[0] - 1
 
     source = "".join(source_lines[start:end])
@@ -66,29 +69,48 @@ def format_file(path, check=False, write=True):
         lines = fh.readlines()
 
     script_node = parser.root.child_with_tag("script")
-    template_node = parser.root.child_with_tag("template")
+    template_nodes = [
+        node
+        for node in parser.root.children
+        if not hasattr(node, "tag") or node.tag != "script"
+    ]
 
     script_content, script_location = format_script(path, script_node, lines, check)
-    template_content, template_location = format_template(
-        template_node, lines, parser=parser
-    )
-
-    changed = (
-        lines[script_location[0] : script_location[1]] != script_content
-        or lines[template_location[0] : template_location[1]] != template_content
+    formatted_template_nodes = [
+        format_template(node, lines, parser=parser) for node in template_nodes
+    ]
+
+    changed_script = lines[script_location[0] : script_location[1]] != script_content
+    changed_template = any(
+        [
+            lines[template_location[0] : template_location[1]] != template_content
+            for template_content, template_location in formatted_template_nodes
+        ]
     )
+    needs_newline_at_end_of_file = not lines[-1].endswith("\n")
+    changed = changed_script or changed_template or needs_newline_at_end_of_file
     if check:
         if changed:
             logger.warning(f"Would change: {path}")
             return 1
         return 0
 
-    if script_location[0] > template_location[0]:
-        lines[script_location[0] : script_location[1]] = script_content
-        lines[template_location[0] : template_location[1]] = template_content
-    else:
-        lines[script_location[0] : script_location[1]] = script_content
-        lines[template_location[0] : template_location[1]] = template_content
+    formatted_parts = reversed(
+        sorted(
+            [
+                (script_content, script_location),
+                *formatted_template_nodes,
+            ],
+            key=lambda x: x[1][0],
+        )
+    )
+
+    for formatted_content, (start, end) in formatted_parts:
+        lines[start:end] = formatted_content
+
+    if needs_newline_at_end_of_file:
+        lines.append("\n")
+
     if not write:
         return lines
 

ruff_cgx/template_formatter.py

@@ -23,6 +23,9 @@
 
 
 def format_template(template_node, lines, parser):
+    """
+    Returns formatted node and the original location of the template node
+    """
     # Find beginning and end of script block
     start, end = template_node.location[0] - 1, template_node.end[0]
 

tests/data/no_template.cgx

@@ -0,0 +1,7 @@
+<node />
+
+<script>
+from collagraph import Component
+class Node(Component):
+	pass
+</script>

tests/data/no_template_elaborate.cgx

@@ -0,0 +1,18 @@
+<node />
+
+
+
+
+<script>
+from collagraph import Component
+class Node(Component):
+	pass
+</script>
+
+
+
+<other-node>
+
+
+	<should-work-just-fine />
+		</other-node>

tests/test_formatter.py

@@ -105,3 +105,70 @@ class Simple(Component):
     stdout = capsys.readouterr().out
 
     assert "1 file reformatted" in stdout, stdout
+
+
+def test_works_with_no_template(capsys, data_path):
+    """
+    Also checks that a newline will be added at the end
+    of the file.
+    """
+    template_cgx = data_path / "no_template.cgx"
+
+    lines = format_file(template_cgx, write=False)
+
+    expected = textwrap.dedent(
+        """
+            <node />
+
+            <script>
+            from collagraph import Component
+
+
+            class Node(Component):
+                pass
+            </script>
+        """
+    ).lstrip()
+    assert "".join(lines) == expected
+
+    stdout = capsys.readouterr().out
+
+    assert "1 file reformatted" in stdout, stdout
+
+
+def test_works_with_no_template_elaborate(capsys, data_path):
+    """
+    Also checks that whitespace between root nodes is preserved.
+    """
+    template_cgx = data_path / "no_template_elaborate.cgx"
+
+    lines = format_file(template_cgx, write=False)
+
+    expected = textwrap.dedent(
+        """
+            <node />
+
+
+
+
+            <script>
+            from collagraph import Component
+
+
+            class Node(Component):
+                pass
+            </script>
+
+
+
+            <other-node>
+              <should-work-just-fine />
+            </other-node>
+
+        """
+    ).lstrip()
+    assert "".join(lines) == expected
+
+    stdout = capsys.readouterr().out
+
+    assert "1 file reformatted" in stdout, stdout