Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat: Add Zig support (#2688)

Andrew Dunbarbed9c4355215
diff --git a/Cargo.lock b/Cargo.lock
index e24667a35..e60a359d2 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2756,6 +2756,7 @@ dependencies = [
"tree-sitter-swift",
"tree-sitter-toml-ng",
"tree-sitter-typescript",
+ "tree-sitter-zig",
]
[[package]]
@@ -6073,6 +6074,16 @@ dependencies = [
"tree-sitter-language",
]
+[[package]]
+name = "tree-sitter-zig"
+version = "1.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ab11fc124851b0db4dd5e55983bbd9631192e93238389dcd44521715e5d53e28"
+dependencies = [
+ "cc",
+ "tree-sitter-language",
+]
+
[[package]]
name = "trie-rs"
version = "0.4.2"
diff --git a/harper-comments/Cargo.toml b/harper-comments/Cargo.toml
index 1ca80bf6b..dfb0b8df2 100644
--- a/harper-comments/Cargo.toml
+++ b/harper-comments/Cargo.toml
@@ -35,6 +35,7 @@ tree-sitter-toml-ng = "0.7.0"
tree-sitter-typescript = "0.23.2"
harper-tree-sitter-dart = "0.0.5"
tree-sitter-clojure = "0.1.0"
+tree-sitter-zig = "1.1.2"
[dev-dependencies]
paste = "1.0.15"
diff --git a/harper-comments/src/comment_parser.rs b/harper-comments/src/comment_parser.rs
index 47dbebb93..2c7d5a49c 100644
--- a/harper-comments/src/comment_parser.rs
+++ b/harper-comments/src/comment_parser.rs
@@ -48,6 +48,7 @@ impl CommentParser {
"toml" => tree_sitter_toml_ng::LANGUAGE,
"typescript" => tree_sitter_typescript::LANGUAGE_TYPESCRIPT,
"typescriptreact" => tree_sitter_typescript::LANGUAGE_TSX,
+ "zig" => tree_sitter_zig::LANGUAGE,
_ => return None,
};
@@ -107,6 +108,7 @@ impl CommentParser {
"toml" => "toml",
"ts" => "typescript",
"tsx" => "typescriptreact",
+ "zig" => "zig",
_ => return None,
})
}
diff --git a/harper-comments/tests/language_support.rs b/harper-comments/tests/language_support.rs
index 8a0683f6c..075d7d5e0 100644
--- a/harper-comments/tests/language_support.rs
+++ b/harper-comments/tests/language_support.rs
@@ -69,6 +69,10 @@ create_test!(ignore_comments.rs, 1);
create_test!(ignore_comments.c, 1);
create_test!(ignore_comments.sol, 1);
+// Zig tests - covering //, ///, and //! comments
+create_test!(clean.zig, 0);
+create_test!(dirty.zig, 5);
+
// These are to make sure nothing crashes.
create_test!(empty.js, 0);
create_test!(issue_229.js, 0);
diff --git a/harper-comments/tests/language_support_sources/clean.zig b/harper-comments/tests/language_support_sources/clean.zig
new file mode 100644
index 000000000..d25642c5d
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/clean.zig
@@ -0,0 +1,14 @@
+//! Top-level module documentation.
+
+/// Main entry point.
+pub fn main() void {
+ // Regular comment.
+ const x: i32 = 42;
+ _ = x;
+}
+
+/// A simple struct.
+pub const MyStruct = struct {
+ /// A field.
+ value: i32,
+};
diff --git a/harper-comments/tests/language_support_sources/dirty.zig b/harper-comments/tests/language_support_sources/dirty.zig
new file mode 100644
index 000000000..3e877b05e
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/dirty.zig
@@ -0,0 +1,8 @@
+//! This module demonstrates various comment types.
+
+/// This doc comment has a mispelling: teh quick brown fox.
+pub fn main() void {
+ // This regular comment has a speling error here
+ const x: i32 = 42;
+ _ = x;
+}