Add support for terraform. Closes #304

Author: SofusA

Cargo.lock

@@ -80,6 +80,7 @@ tree-sitter-typescript = "0.23.2"
 tree-sitter-vhdl = "<2"
 tree-sitter-yaml = "0.7.2"
 tree-sitter-zig = "<2"
+tree-sitter-hcl = "1.1"
 codebook-tree-sitter-just = "<0.2.0"
 codebook-tree-sitter-latex = "<0.7.0"
 codebook-tree-sitter-typst = "<0.13.0"

Cargo.toml

@@ -58,6 +58,7 @@ codebook-tree-sitter-typst.workspace = true
 tree-sitter-yaml.workspace = true
 tree-sitter-zig.workspace = true
 tree-sitter-c-sharp.workspace = true
+tree-sitter-hcl.workspace = true
 tree-sitter.workspace = true
 unicase.workspace = true
 unicode-script.workspace = true

crates/codebook/Cargo.toml

@@ -37,6 +37,7 @@ pub enum LanguageType {
     VHDL,
     YAML,
     Zig,
+    Hcl,
 }
 
 impl FromStr for LanguageType {
@@ -312,6 +313,13 @@ pub static LANGUAGE_SETTINGS: &[LanguageSetting] = &[
         query: include_str!("queries/vhdl.scm"),
         extensions: &["vhd", "vhdl"],
     },
+    LanguageSetting {
+        type_: LanguageType::Hcl,
+        ids: &["hcl", "terraform"],
+        dictionary_ids: &["hcl"],
+        query: include_str!("queries/hcl.scm"),
+        extensions: &["tf", "tfvars"],
+    },
 ];
 
 #[derive(Debug)]
@@ -360,6 +368,7 @@ impl LanguageSetting {
             LanguageType::VHDL => Some(tree_sitter_vhdl::LANGUAGE.into()),
             LanguageType::YAML => Some(tree_sitter_yaml::LANGUAGE.into()),
             LanguageType::Zig => Some(tree_sitter_zig::LANGUAGE.into()),
+            LanguageType::Hcl => Some(tree_sitter_hcl::LANGUAGE.into()),
         }
     }
 }

crates/codebook/src/queries.rs

@@ -0,0 +1,5 @@
+(comment) @comment
+
+(attribute (identifier) @identifier.field)
+
+(template_literal) @string

crates/codebook/src/queries/hcl.scm

@@ -11,6 +11,7 @@ mod test_erlang;
 mod test_files;
 mod test_go;
 mod test_haskell;
+mod test_hcl;
 mod test_java;
 mod test_javascript;
 mod test_just;

crates/codebook/tests/languages/main.rs

@@ -0,0 +1,102 @@
+use codebook::queries::LanguageType;
+
+use super::utils::{assert_spelling, assert_spelling_at};
+
+#[test]
+fn test_hcl_attribute_identifiers() {
+    let sample_text = r#"
+resource "aws_instance" "web_server" {
+    instnace_type = "t3.micro"
+    descriptin    = "Valid text"
+}
+"#;
+
+    assert_spelling(
+        LanguageType::Hcl,
+        sample_text,
+        &["instnace", "descriptin"],
+        &["resource", "aws_instance", "web_server"],
+    );
+}
+
+#[test]
+fn test_hcl_strings_and_comments() {
+    let sample_text = r#"
+# Comment with a speling error.
+
+/* Multi-line comment
+with an error on the seconnd line. */
+
+variable "region" {
+    description = "Cloud regon for the deploymant."
+    default     = "eu-west-1"
+}
+
+resource "aws_instance" "web_server" {
+    user_data = <<-EOT
+        Configure the servver for this environment.
+        Enable applicaton logging for ${var.region}.
+    EOT
+}
+"#;
+
+    assert_spelling_at(
+        LanguageType::Hcl,
+        sample_text,
+        &[
+            ("speling", &[0]),
+            ("seconnd", &[0]),
+            ("regon", &[0]),
+            ("deploymant", &[0]),
+            ("servver", &[0]),
+            ("applicaton", &[0]),
+        ],
+    );
+}
+
+#[test]
+fn test_hcl_only_checks_identifier_definitions() {
+    let sample_text = r#"
+variable "source_value" {
+    default = "valid"
+}
+
+locals {
+    misspeled_value = var.source_value
+}
+
+output "result" {
+    value = local.misspeled_value
+}
+"#;
+
+    assert_spelling_at(
+        LanguageType::Hcl,
+        sample_text,
+        &[
+            // The attribute name is checked at its definition, but the same
+            // text in the traversal expression is not checked as a usage.
+            ("misspeled", &[0]),
+        ],
+    );
+}
+
+#[test]
+fn test_hcl_string_interpolation() {
+    let sample_text = r#"
+variable "region" {
+    default = "eu-west-1"
+}
+
+locals {
+    message = "Deploy to the regon ${var.misspeled_reference}"
+}
+"#;
+
+    assert_spelling(
+        LanguageType::Hcl,
+        sample_text,
+        &["regon"],
+        &["misspeled_reference"],
+    );
+}

crates/codebook/tests/languages/test_hcl.rs

@@ -0,0 +1,31 @@
+# Provision the applicaton infrastructure for the staging enviroment.
+
+terraform {
+  required_version = ">= 1.5.0"
+}
+
+variable "region" {
+  description = "Cloud regon used for the deployment."
+  type        = string
+  default     = "eu-west-1"
+}
+
+resource "aws_instance" "web_server" {
+  ami           = "ami-12345678"
+  instance_type = "t3.micro"
+
+  tags = {
+    Name        = "Applicaton server"
+    Description = "Handles incoming requsts"
+  }
+
+  user_data = <<-EOT
+    Configure the servver for the staging environment.
+    Enable applicaton logging.
+  EOT
+}
+
+output "instance_id" {
+  description = "Identifer of the created instance."
+  value       = aws_instance.web_server.id
+}