Skip to content

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

feat: added languages, matchers and a test

Elijah Potter93589093e9fc
diff --git a/Cargo.lock b/Cargo.lock
index 9d8a91516..3d5d775ab 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -506,10 +506,12 @@ dependencies = [
"itertools 0.12.1",
"paste",
"tree-sitter",
+ "tree-sitter-bash",
"tree-sitter-c",
"tree-sitter-c-sharp",
"tree-sitter-cpp",
"tree-sitter-go",
+ "tree-sitter-java",
"tree-sitter-javascript",
"tree-sitter-lua",
"tree-sitter-python",
@@ -1376,6 +1378,16 @@ dependencies = [
"regex",
]
+[[package]]
+name = "tree-sitter-bash"
+version = "0.20.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "57da2032c37eb2ce29fd18df7d3b94355fec8d6d854d8f80934955df542b5906"
+dependencies = [
+ "cc",
+ "tree-sitter",
+]
+
[[package]]
name = "tree-sitter-c"
version = "0.20.8"
@@ -1416,6 +1428,16 @@ dependencies = [
"tree-sitter",
]
+[[package]]
+name = "tree-sitter-java"
+version = "0.20.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2adc5696bf5abf761081d7457d2bb82d0e3b28964f4214f63fd7e720ef462653"
+dependencies = [
+ "cc",
+ "tree-sitter",
+]
+
[[package]]
name = "tree-sitter-javascript"
version = "0.20.4"
diff --git a/harper-comments/Cargo.toml b/harper-comments/Cargo.toml
index fd7f6a741..53fbb0b01 100644
--- a/harper-comments/Cargo.toml
+++ b/harper-comments/Cargo.toml
@@ -22,6 +22,8 @@ tree-sitter-swift = "=0.4.0"
tree-sitter-c-sharp = "0.20.0"
tree-sitter-toml = "0.20.0"
tree-sitter-lua = "0.0.19"
+tree-sitter-bash = "0.20.0"
+tree-sitter-java = "0.20.0"
itertools = "0.12.1"
[dev-dependencies]
diff --git a/harper-comments/src/tree_sitter_parser.rs b/harper-comments/src/tree_sitter_parser.rs
index 926a02c64..c17d06bbf 100644
--- a/harper-comments/src/tree_sitter_parser.rs
+++ b/harper-comments/src/tree_sitter_parser.rs
@@ -32,6 +32,8 @@ impl TreeSitterParser {
"csharp" => tree_sitter_c_sharp::language(),
"toml" => tree_sitter_toml::language(),
"lua" => tree_sitter_lua::language(),
+ "sh" => tree_sitter_bash::language(),
+ "java" => tree_sitter_java::language(),
_ => return None
};
@@ -73,6 +75,9 @@ impl TreeSitterParser {
"cs" => "csharp",
"toml" => "toml",
"lua" => "lua",
+ "sh" => "sh",
+ "bash" => "sh",
+ "java" => "java",
_ => return None
})
}
diff --git a/harper-comments/tests/language_support.rs b/harper-comments/tests/language_support.rs
index 228d173e8..a2ab82aa6 100644
--- a/harper-comments/tests/language_support.rs
+++ b/harper-comments/tests/language_support.rs
@@ -38,5 +38,5 @@ macro_rules! create_test {
create_test!(multiline_comments.cpp, 3);
create_test!(multiline_comments.ts, 3);
create_test!(clean.rs, 0);
-create_test!(jsdoc.ts, 3);
+create_test!(jsdoc.ts, 4);
create_test!(issue_96.lua, 0);
diff --git a/harper-comments/tests/language_support_sources/jsdoc.ts b/harper-comments/tests/language_support_sources/jsdoc.ts
index c684017bf..cf19f6fc1 100644
--- a/harper-comments/tests/language_support_sources/jsdoc.ts
+++ b/harper-comments/tests/language_support_sources/jsdoc.ts
@@ -9,3 +9,22 @@ class Clazz { }
/** Here is another example: {@link this sould also b unchecked}. But this _sould_ be.*/
/** However, tis should be checked, while {@link tis should not} */
+
+/**
+ * The following examples should be ignored by Harper.
+ *
+ * @param {string} n - ignor
+ * @param {string} [o] - ignor
+ * @param {string} [d=DefaultValue] - ignor
+ * @return {string} ignor
+ *
+ * This should not be ignor
+ *
+ * @example
+ *
+ * foo('hello')
+ */
+
+function foo(n, o, d) {
+ return n
+}
diff --git a/harper-core/src/linting/matcher.rs b/harper-core/src/linting/matcher.rs
index 94e381fcb..46e800001 100644
--- a/harper-core/src/linting/matcher.rs
+++ b/harper-core/src/linting/matcher.rs
@@ -277,7 +277,10 @@ impl Matcher {
"water", "melon" => "watermelon",
"wee", "kend" => "weekend",
"with", "in" => "within",
- "with", "out" => "without"
+ "with", "out" => "without",
+ "TreeSitter" => "Tree-sitter",
+ "Treesitter" => "Tree-sitter",
+ "Tree", "sitter" => "Tree-sitter"
};
// TODO: Improve the description for this lint specifically.
diff --git a/justfile b/justfile
index 4ec88bd77..352e7323c 100644
--- a/justfile
+++ b/justfile
@@ -60,9 +60,8 @@ precommit:
set -eo pipefail
just check
+ just test
- cargo test
- cargo test --release
cargo doc
cargo build
cargo build --release
@@ -70,3 +69,20 @@ precommit:
just build-obsidian
just build-web
+
+install:
+ cargo install --path harper-ls
+ cargo install --path harper-cli
+
+# Run `harper-cli` on the Harper repository
+dogfood:
+ #! /bin/bash
+ for file in `fd -e rs`
+ do
+ echo Linting $file
+ cargo run --bin harper-cli --quiet -- lint $file
+ done
+
+test:
+ cargo test
+ cargo test --release