rbtr-lang-hcl 2026.7.0.dev0__py3-none-any.whl

rbtr_lang_hcl/__init__.py

@@ -0,0 +1 @@
+"""HCL language plugin package."""

rbtr_lang_hcl/hcl.scm

@@ -0,0 +1,6 @@
+; Comments (HCL: `#`, `//`, `/* */` — all `comment`).
+(comment) @comment
+
+(config_file
+  (body
+    (block) @config_key))

rbtr_lang_hcl/plugin.py

@@ -0,0 +1,60 @@
+"""HCL language plugin.
+
+Extracts each top-level block as a config-key chunk, via a
+tree-sitter query. The block name combines its type and labels.
+
+Extracted chunks::
+
+    resource "aws_instance" "web" {}  → config_key "resource aws_instance web"
+    variable "region" {}              → config_key "variable region"
+    terraform {}                      → config_key "terraform"
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from rbtr.languages.registration import (
+    LanguageRegistration,
+    NameResolver,
+    QueryExtraction,
+    load_query,
+)
+
+if TYPE_CHECKING:
+    from tree_sitter import Node
+
+# Top-level blocks only: a `block` whose body is the file's own body,
+# not one nested inside another block.
+
+
+hcl = LanguageRegistration(
+    id="hcl",
+    extensions=frozenset({".hcl", ".tf"}),
+    grammar_module="tree_sitter_hcl",
+    extraction=QueryExtraction(
+        query=load_query(__package__, "hcl"),
+    ),
+    extraction_serial=4,
+)
+
+
+@hcl.name_extractor
+def hcl_block_name(
+    resolver: NameResolver, capture_name: str, node: Node, captures: dict[str, list[Node]]
+) -> str:
+    """Name a top-level HCL block by its type and labels.
+
+    `resource "aws_instance" "web"` → `"resource aws_instance web"`;
+    a bare `terraform {}` block → `"terraform"`. Non-block captures
+    fall back to the default resolver.
+    """
+    if capture_name != "config_key":
+        return resolver(capture_name, node, captures)
+    labels: list[str] = []
+    for child in node.children:
+        if child.type == "identifier" and child.text:
+            labels.append(child.text.decode("utf-8", errors="replace"))
+        elif child.type == "string_lit" and child.text:
+            labels.append(child.text.decode("utf-8", errors="replace").strip('"'))
+    return " ".join(labels)

rbtr_lang_hcl/tests/__snapshots__/test_samples/test_edges_match_snapshot.json

@@ -0,0 +1 @@
+[]

rbtr_lang_hcl/tests/__snapshots__/test_samples/test_extraction_matches_snapshot.json

@@ -0,0 +1,92 @@
+[
+  {
+    "id": "ee86eb0e9a970b30",
+    "blob_sha": "sha1",
+    "file_path": "main.tf",
+    "kind": "comment",
+    "name": "<anonymous>",
+    "scope": "",
+    "language": "hcl",
+    "content": "# Greeter service infrastructure.\n#\n# The HCL plugin extracts each top-level block as a doc section, named by its\n# type and labels: a bare block by its type (terraform), a variable/output by\n# its name, a resource by its type and name.",
+    "line_start": 1,
+    "line_end": 5,
+    "metadata": {
+      "module": "",
+      "names": "",
+      "dots": "",
+      "language_hint": ""
+    }
+  },
+  {
+    "id": "9a3479950102c0b7",
+    "blob_sha": "sha1",
+    "file_path": "main.tf",
+    "kind": "config_key",
+    "name": "terraform",
+    "scope": "",
+    "language": "hcl",
+    "content": "terraform {\n  required_version = \">= 1.5\"\n}",
+    "line_start": 7,
+    "line_end": 9,
+    "metadata": {
+      "module": "",
+      "names": "",
+      "dots": "",
+      "language_hint": ""
+    }
+  },
+  {
+    "id": "6a9efd680841aa5e",
+    "blob_sha": "sha1",
+    "file_path": "main.tf",
+    "kind": "config_key",
+    "name": "variable region",
+    "scope": "",
+    "language": "hcl",
+    "content": "variable \"region\" {\n  description = \"Deployment region for the greeter service.\"\n  type        = string\n  default     = \"us-east-1\"\n}",
+    "line_start": 11,
+    "line_end": 15,
+    "metadata": {
+      "module": "",
+      "names": "",
+      "dots": "",
+      "language_hint": ""
+    }
+  },
+  {
+    "id": "457a0958f846de57",
+    "blob_sha": "sha1",
+    "file_path": "main.tf",
+    "kind": "config_key",
+    "name": "resource aws_instance greeter",
+    "scope": "",
+    "language": "hcl",
+    "content": "resource \"aws_instance\" \"greeter\" {\n  ami           = \"ami-0abc123\"\n  instance_type = \"t3.micro\"\n\n  tags = {\n    Name = \"greeter\"\n  }\n}",
+    "line_start": 17,
+    "line_end": 24,
+    "metadata": {
+      "module": "",
+      "names": "",
+      "dots": "",
+      "language_hint": ""
+    }
+  },
+  {
+    "id": "633460e780957025",
+    "blob_sha": "sha1",
+    "file_path": "main.tf",
+    "kind": "config_key",
+    "name": "output greeter_ip",
+    "scope": "",
+    "language": "hcl",
+    "content": "output \"greeter_ip\" {\n  description = \"Public IP of the greeter instance.\"\n  value       = aws_instance.greeter.public_ip\n}",
+    "line_start": 26,
+    "line_end": 29,
+    "metadata": {
+      "module": "",
+      "names": "",
+      "dots": "",
+      "language_hint": ""
+    }
+  }
+]

rbtr_lang_hcl/tests/cases_extraction.py

@@ -0,0 +1,29 @@
+"""HCL extraction test cases (top-level blocks -> config_key)."""
+
+from __future__ import annotations
+
+from pytest_cases import case
+
+type SymbolCase = tuple[str, str, list[tuple[str, str, str]]]
+
+
+@case(tags=["symbol"])
+def case_hcl_splits_by_blocks() -> SymbolCase:
+    """HCL splits by top-level blocks."""
+    src = """\
+resource "aws_instance" "web" {
+  ami = "ami-12345"
+}
+
+variable "region" {
+  default = "us-east-1"
+}
+"""
+    return (
+        "hcl",
+        src,
+        [
+            ("config_key", "resource aws_instance web", ""),
+            ("config_key", "variable region", ""),
+        ],
+    )

rbtr_lang_hcl/tests/samples/hcl/main.tf

@@ -0,0 +1,29 @@
+# Greeter service infrastructure.
+#
+# The HCL plugin extracts each top-level block as a doc section, named by its
+# type and labels: a bare block by its type (terraform), a variable/output by
+# its name, a resource by its type and name.
+
+terraform {
+  required_version = ">= 1.5"
+}
+
+variable "region" {
+  description = "Deployment region for the greeter service."
+  type        = string
+  default     = "us-east-1"
+}
+
+resource "aws_instance" "greeter" {
+  ami           = "ami-0abc123"
+  instance_type = "t3.micro"
+
+  tags = {
+    Name = "greeter"
+  }
+}
+
+output "greeter_ip" {
+  description = "Public IP of the greeter instance."
+  value       = aws_instance.greeter.public_ip
+}

rbtr_lang_hcl/tests/test_extraction.py

@@ -0,0 +1,17 @@
+"""HCL extraction tests (cases in `cases_extraction.py`)."""
+
+from __future__ import annotations
+
+from pytest_cases import parametrize_with_cases
+
+from rbtr.git import FileEntry
+from rbtr.languages.extract import extract_file
+
+
+@parametrize_with_cases("lang, source, expected", cases=".cases_extraction", has_tag="symbol")
+def test_extracts_expected_symbols(lang: str, source: str, expected: list) -> None:
+    """Each expected (kind, name, scope) tuple appears in the output."""
+    chunks = extract_file(FileEntry("input", "sha1", source.encode()), lang)
+    symbols = [(c.kind, c.name, c.scope) for c in chunks]
+    for exp in expected:
+        assert exp in symbols, f"expected {exp} not found in {symbols}"

rbtr_lang_hcl/tests/test_samples.py

@@ -0,0 +1,68 @@
+"""HCL sample extraction: the `samples/hcl/` project through the real pipeline."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import pytest
+from tree_sitter import Parser
+
+from rbtr.git import FileEntry
+from rbtr.index.models import Chunk, ChunkKind, Edge
+from rbtr.languages.edges import build_resolution_map, infer_import_edges
+from rbtr.languages.extract import extract_file
+from rbtr.languages.manager import get_manager
+from rbtr.testing import render_edges
+
+if TYPE_CHECKING:
+    from syrupy.assertion import SnapshotAssertion
+
+
+@pytest.fixture
+def project() -> list[tuple[str, str]]:
+    root = Path(__file__).parent / "samples" / "hcl"
+    return [
+        (str(p.relative_to(root)), p.read_text()) for p in sorted(root.rglob("*")) if p.is_file()
+    ]
+
+
+@pytest.fixture
+def chunks(project: list[tuple[str, str]]) -> list[Chunk]:
+    manager = get_manager()
+    out: list[Chunk] = []
+    for path, text in project:
+        lang = manager.detect_language(path) or "hcl"
+        out.extend(extract_file(FileEntry(path, "sha1", text.encode()), lang))
+    return out
+
+
+@pytest.fixture
+def edges(project: list[tuple[str, str]], chunks: list[Chunk]) -> list[Edge]:
+    manager = get_manager()
+    repo_files = {path for path, _ in project}
+    return infer_import_edges(chunks, repo_files, build_resolution_map(manager))
+
+
+def test_emits_expected_kinds(chunks: list[Chunk]) -> None:
+    """The sample exercises HCL's config-key chunks."""
+    kinds = {c.kind for c in chunks}
+    assert {ChunkKind.CONFIG_KEY, ChunkKind.COMMENT} <= kinds
+
+
+def test_parses_cleanly(project: list[tuple[str, str]]) -> None:
+    manager = get_manager()
+    for path, text in project:
+        grammar = manager.grammar(manager.detect_language(path) or "hcl")
+        assert grammar is not None
+        assert not Parser(grammar).parse(text.encode()).root_node.has_error, path
+
+
+def test_extraction_matches_snapshot(chunks: list[Chunk], snapshot_json: SnapshotAssertion) -> None:
+    assert chunks == snapshot_json
+
+
+def test_edges_match_snapshot(
+    chunks: list[Chunk], edges: list[Edge], snapshot_json: SnapshotAssertion
+) -> None:
+    assert render_edges(edges, chunks) == snapshot_json

rbtr_lang_hcl-2026.7.0.dev0.dist-info/METADATA

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: rbtr-lang-hcl
+Version: 2026.7.0.dev0
+Summary: rbtr — HCL / Terraform language plugin
+License-Expression: MIT
+Requires-Dist: rbtr==2026.7.0.dev0
+Requires-Dist: tree-sitter-hcl
+Requires-Python: >=3.13

rbtr_lang_hcl-2026.7.0.dev0.dist-info/RECORD

@@ -0,0 +1,15 @@
+rbtr_lang_hcl/__init__.py,sha256=Fti9IHmwC5o-nqrNdnsGmMmzKZl2OCNJJ6jFo2XjDKQ,35
+rbtr_lang_hcl/hcl.scm,sha256=CAuqcIBJ66vCfM7ieB7TH_ddkfE_b5XpBu4oVtNveAA,123
+rbtr_lang_hcl/plugin.py,sha256=80fI2ix3ewuQS6C654JlR8i5CQzeubkzPnYwg4zpJYM,1818
+rbtr_lang_hcl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rbtr_lang_hcl/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rbtr_lang_hcl/tests/__snapshots__/test_samples/test_edges_match_snapshot.json,sha256=N1F-Xz3GaBn2H1p7uKzhkhKCQV8QVR0t76XD6wmFtXA,3
+rbtr_lang_hcl/tests/__snapshots__/test_samples/test_extraction_matches_snapshot.json,sha256=CJhfX0RebBLX5UgtHt8cQFU451sEUEPX26wxg_opyPE,2494
+rbtr_lang_hcl/tests/cases_extraction.py,sha256=RWDkex1xlE565Sru2a0fAoMdChZMoe6L4o8wei4t-AM,610
+rbtr_lang_hcl/tests/samples/hcl/main.tf,sha256=KlPG1rYpQ45PVYekieGqzxB99Vmy2mIJ_cdCrvhqSBg,679
+rbtr_lang_hcl/tests/test_extraction.py,sha256=JEh4BrD60DKJ8WcEU-I4pUZOwYAU0Hp2aOQ0Lkwqw4Y,712
+rbtr_lang_hcl/tests/test_samples.py,sha256=7smMQp1Q67M44NRO1j3f_BU5emK6iaY8jTHpVZGkGGs,2225
+rbtr_lang_hcl-2026.7.0.dev0.dist-info/WHEEL,sha256=CoDSoyhtC_eO_tlxRYzsTraPv1fPJRXFx91k6ISeAvA,81
+rbtr_lang_hcl-2026.7.0.dev0.dist-info/entry_points.txt,sha256=I7_liJWjgbs_MJHvnE70kT0Hjh8KTq8T1hlaiHJ5To8,49
+rbtr_lang_hcl-2026.7.0.dev0.dist-info/METADATA,sha256=FJ1vk6qbBUqJlIvHHFqaniRn4JPLE-qMpbnGdDbB9wk,229
+rbtr_lang_hcl-2026.7.0.dev0.dist-info/RECORD,,

rbtr_lang_hcl-2026.7.0.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.28
+Root-Is-Purelib: true
+Tag: py3-none-any

rbtr_lang_hcl-2026.7.0.dev0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[rbtr.languages]
+hcl = rbtr_lang_hcl.plugin:hcl
+