Add support for yaml inline comments

- consider YAML inline comments, e.g. key1:value1 #comment1
- add respective TCs

Author: patdhlk

src/sphinx_codelinks/analyse/utils.py

@@ -181,9 +181,33 @@ def find_yaml_next_structure(node: TreeSitterNode) -> TreeSitterNode | None:
     return None
 
 
+def find_yaml_prev_sibling_on_same_row(node: TreeSitterNode) -> TreeSitterNode | None:
+    """Find a previous named sibling that is on the same row as the comment."""
+    comment_row = node.start_point.row
+    current = node.prev_named_sibling
+
+    while current:
+        # Check if this sibling ends on the same row as the comment starts
+        # This indicates it's an inline comment
+        if current.end_point.row == comment_row:
+            return current
+        # If we find a sibling that ends before the comment row, we can stop
+        # as we won't find any siblings on the same row going backwards
+        if current.end_point.row < comment_row:
+            break
+        current = current.prev_named_sibling
+
+    return None
+
+
 def find_yaml_associated_structure(node: TreeSitterNode) -> TreeSitterNode | None:
     """Find the YAML structure (key-value pair, list item, etc.) associated with a comment."""
-    # First, try to find the next named sibling (structure after the comment)
+    # First, check if this is an inline comment by looking for a previous sibling on the same row
+    prev_sibling_same_row = find_yaml_prev_sibling_on_same_row(node)
+    if prev_sibling_same_row:
+        return prev_sibling_same_row
+
+    # If no previous sibling on same row, try to find the next named sibling (structure after the comment)
     structure = find_yaml_next_structure(node)
     if structure:
         return structure

tests/test_analyse_utils.py

@@ -1242,3 +1242,134 @@ def test_yaml_document_structure(init_yaml_tree_sitter):
     assert second_structure, "No structure found for second comment"
     second_text = second_structure.text.decode("utf-8")
     assert "config.yml:" in second_text
+
+
+def test_yaml_inline_comments_current_behavior(init_yaml_tree_sitter):
+    """Test improved behavior of inline comments in YAML after the fix."""
+    code = b"""key1: value1  # inline comment about key1
+key2: value2
+key3: value3  # inline comment about key3
+"""
+
+    parser, query = init_yaml_tree_sitter
+    comments = utils.extract_comments(code, parser, query)
+    comments.sort(key=lambda x: x.start_point.row)
+
+    assert len(comments) == 2, f"Expected 2 comments, found {len(comments)}"
+
+    # Fixed behavior: inline comment about key1 now correctly associates with key1
+    first_structure = utils.find_yaml_associated_structure(comments[0])
+    assert first_structure, "No structure found for first comment"
+    first_text = first_structure.text.decode("utf-8")
+    assert "key1:" in first_text, f"Expected 'key1:' in '{first_text}'"
+
+    # Fixed behavior: inline comment about key3 now correctly associates with key3
+    second_structure = utils.find_yaml_associated_structure(comments[1])
+    assert second_structure, "No structure found for second comment"
+    second_text = second_structure.text.decode("utf-8")
+    assert "key3:" in second_text, f"Expected 'key3:' in '{second_text}'"
+
+
+@pytest.mark.parametrize(
+    ("code", "expected_associations"),
+    [
+        # Basic inline comment case
+        (
+            b"""key1: value1  # comment about key1
+key2: value2
+            """,
+            ["key1:"],  # Now correctly associates with key1
+        ),
+        # Multiple inline comments
+        (
+            b"""database:
+  host: localhost  # production server
+  port: 5432       # default postgres port
+  user: admin
+            """,
+            [
+                "host: localhost",
+                "port: 5432",
+            ],  # Now correctly associates with the right structures
+        ),
+    ],
+)
+def test_yaml_inline_comments_fixed_behavior(
+    code, expected_associations, init_yaml_tree_sitter
+):
+    """Test that inline comments now correctly associate with the structure they comment on."""
+    parser, query = init_yaml_tree_sitter
+    comments = utils.extract_comments(code, parser, query)
+    comments.sort(key=lambda x: x.start_point.row)
+
+    assert len(comments) == len(expected_associations), (
+        f"Expected {len(expected_associations)} comments, found {len(comments)}"
+    )
+
+    for i, comment in enumerate(comments):
+        structure = utils.find_yaml_associated_structure(comment)
+        assert structure, f"No structure found for comment {i}"
+        structure_text = structure.text.decode("utf-8")
+        assert expected_associations[i] in structure_text, (
+            f"Expected '{expected_associations[i]}' in structure text: '{structure_text}'"
+        )
+
+
+@pytest.mark.parametrize(
+    ("code", "expected_associations"),
+    [
+        # Inline comments with list items
+        (
+            b"""items:
+  - name: item1  # first item
+  - name: item2  # second item
+            """,
+            [
+                "name: item1",
+                "name: item2",
+            ],  # The inline comment finds the key-value pair within the list item
+        ),
+        # Mixed inline and block comments
+        (
+            b"""# Block comment for database
+database:
+  host: localhost  # inline comment for host
+  port: 5432
+  # Block comment for user
+  user: admin
+            """,
+            ["database:", "host: localhost", "user: admin"],
+        ),
+        # Inline comments in nested structures
+        (
+            b"""services:
+  web:
+    image: nginx  # web server image
+    ports:
+      - "80:80"   # http port
+            """,
+            ["image: nginx", '- "80:80"'],
+        ),
+    ],
+)
+def test_yaml_inline_comments_comprehensive(
+    code, expected_associations, init_yaml_tree_sitter
+):
+    """Comprehensive test for inline comment behavior in various YAML structures."""
+    parser, query = init_yaml_tree_sitter
+    comments = utils.extract_comments(code, parser, query)
+    comments.sort(key=lambda x: x.start_point.row)
+
+    assert len(comments) == len(expected_associations), (
+        f"Expected {len(expected_associations)} comments, found {len(comments)}"
+    )
+
+    for i, comment in enumerate(comments):
+        structure = utils.find_yaml_associated_structure(comment)
+        assert structure, (
+            f"No structure found for comment {i}: '{comment.text.decode('utf-8')}'"
+        )
+        structure_text = structure.text.decode("utf-8")
+        assert expected_associations[i] in structure_text, (
+            f"Comment {i} '{comment.text.decode('utf-8')}' -> Expected '{expected_associations[i]}' in '{structure_text}'"
+        )