Skip to content

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

feat: PowerShell comments support (#2762)

Elijah Potterac4c636687cb
diff --git a/Cargo.lock b/Cargo.lock
index 1e0403317..9954f04de 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2751,6 +2751,7 @@ dependencies = [
"tree-sitter-lua",
"tree-sitter-nix",
"tree-sitter-php",
+ "tree-sitter-powershell",
"tree-sitter-ruby",
"tree-sitter-rust",
"tree-sitter-scala",
@@ -6025,6 +6026,16 @@ dependencies = [
"tree-sitter-language",
]
+[[package]]
+name = "tree-sitter-powershell"
+version = "0.25.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "415ec6251d133d26b4f62c60721149fe36c315334f47812450187d6ea59cffdf"
+dependencies = [
+ "cc",
+ "tree-sitter-language",
+]
+
[[package]]
name = "tree-sitter-python"
version = "0.25.0"
diff --git a/fuzz/fuzz_targets/fuzz_harper_comment.rs b/fuzz/fuzz_targets/fuzz_harper_comment.rs
index 366c9d871..6d8d42ebf 100644
--- a/fuzz/fuzz_targets/fuzz_harper_comment.rs
+++ b/fuzz/fuzz_targets/fuzz_harper_comment.rs
@@ -7,7 +7,7 @@ use libfuzzer_sys::fuzz_target;
#[derive(Debug)]
struct Language(String);
-const LANGUAGES: [&str; 33] = [
+const LANGUAGES: [&str; 34] = [
"cmake",
"cpp",
"csharp",
@@ -22,6 +22,7 @@ const LANGUAGES: [&str; 33] = [
"lua",
"nix",
"php",
+ "powershell",
"python",
"ruby",
"rust",
diff --git a/harper-comments/Cargo.toml b/harper-comments/Cargo.toml
index 2e4e04756..396d97f74 100644
--- a/harper-comments/Cargo.toml
+++ b/harper-comments/Cargo.toml
@@ -27,6 +27,7 @@ tree-sitter-kotlin-ng = "1.1.0"
tree-sitter-lua = "0.4.1"
tree-sitter-nix = "0.3.0"
tree-sitter-php = "0.24.2"
+tree-sitter-powershell = "0.25.10"
tree-sitter-ruby = "0.23.1"
tree-sitter-rust = "0.24.0"
tree-sitter-scala = "0.24.0"
diff --git a/harper-comments/src/comment_parser.rs b/harper-comments/src/comment_parser.rs
index d687a6e85..077120162 100644
--- a/harper-comments/src/comment_parser.rs
+++ b/harper-comments/src/comment_parser.rs
@@ -40,6 +40,7 @@ impl CommentParser {
"lua" => tree_sitter_lua::LANGUAGE,
"nix" => tree_sitter_nix::LANGUAGE,
"php" => tree_sitter_php::LANGUAGE_PHP,
+ "powershell" => tree_sitter_powershell::LANGUAGE,
"ruby" => tree_sitter_ruby::LANGUAGE,
"rust" => tree_sitter_rust::LANGUAGE,
"scala" => tree_sitter_scala::LANGUAGE,
@@ -101,6 +102,7 @@ impl CommentParser {
"lua" => "lua",
"nix" => "nix",
"php" => "php",
+ "ps1" | "psd1" | "psm1" => "powershell",
"rb" => "ruby",
"rs" => "rust",
"sbt" | "sc" | "scala" | "mill" => "scala",
diff --git a/harper-comments/tests/language_support.rs b/harper-comments/tests/language_support.rs
index cf07e249b..d734d4131 100644
--- a/harper-comments/tests/language_support.rs
+++ b/harper-comments/tests/language_support.rs
@@ -48,6 +48,7 @@ create_test!(clean.lua, 0);
create_test!(dirty.lua, 1);
create_test!(clean.rs, 0);
create_test!(clean.sol, 0);
+create_test!(clean.ps1, 0);
create_test!(jsdoc.ts, 4);
create_test!(issue_96.lua, 0);
create_test!(merged_lines.ts, 1);
@@ -72,6 +73,7 @@ create_test!(basic.clj, 12);
create_test!(ignore_comments.rs, 1);
create_test!(ignore_comments.c, 1);
create_test!(ignore_comments.sol, 1);
+create_test!(ignore_comments.ps1, 1);
// Zig tests - covering //, ///, and //! comments
create_test!(clean.zig, 0);
diff --git a/harper-comments/tests/language_support_sources/clean.ps1 b/harper-comments/tests/language_support_sources/clean.ps1
new file mode 100644
index 000000000..1a883ac4c
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/clean.ps1
@@ -0,0 +1,11 @@
+# This is an example PowerShell file with clean comments.
+
+<#
+This block comment should also lint cleanly.
+It includes multiple lines of text.
+#>
+
+function Invoke-Demo {
+ # This function has no lint issues in its comments.
+ Write-Output "Hello from Harper"
+}
diff --git a/harper-comments/tests/language_support_sources/ignore_comments.ps1 b/harper-comments/tests/language_support_sources/ignore_comments.ps1
new file mode 100644
index 000000000..860abd37a
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/ignore_comments.ps1
@@ -0,0 +1,12 @@
+# spellcheck:ignore splling error
+# Ths applies to this entire comment block.
+
+$foo = 1
+
+# spellchecker: ignore ths varible isnt done yt
+$bar = 2
+
+# Ths comment block is checked.
+function Invoke-Check {
+ Write-Output "Testing"
+}
diff --git a/packages/vscode-plugin/package.json b/packages/vscode-plugin/package.json
index 453b3d465..fc63bab44 100644
--- a/packages/vscode-plugin/package.json
+++ b/packages/vscode-plugin/package.json
@@ -55,6 +55,7 @@
"onLanguage:nix",
"onLanguage:org",
"onLanguage:php",
+ "onLanguage:powershell",
"onLanguage:plaintext",
"onLanguage:python",
"onLanguage:ruby",
diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/powershell.ps1 b/packages/vscode-plugin/src/tests/fixtures/languages/powershell.ps1
new file mode 100644
index 000000000..acb325fc4
--- /dev/null
+++ b/packages/vscode-plugin/src/tests/fixtures/languages/powershell.ps1
@@ -0,0 +1,2 @@
+# Errorz should trigger a spellcheck diagnostic.
+Write-Output "Hello"
diff --git a/packages/vscode-plugin/src/tests/suite/languages.test.ts b/packages/vscode-plugin/src/tests/suite/languages.test.ts
index 614be3ae1..816561e92 100644
--- a/packages/vscode-plugin/src/tests/suite/languages.test.ts
+++ b/packages/vscode-plugin/src/tests/suite/languages.test.ts
@@ -41,6 +41,7 @@ describe('Languages >', () => {
{ type: 'PHP', file: 'php.php', row: 2, column: 31 },
{ type: 'Plaintext without extension', file: 'plaintext', row: 0, column: 0 },
{ type: 'Plaintext with extension', file: 'plaintext.txt', row: 4, column: 0 },
+ { type: 'PowerShell', file: 'powershell.ps1', row: 0, column: 2 },
{ type: 'Python', file: 'python.py', row: 1, column: 2 },
{ type: 'Ruby', file: 'ruby.rb', row: 3, column: 16 },
{ type: 'Rust', file: 'rust.rs', row: 0, column: 4 },
diff --git a/packages/web/src/routes/docs/integrations/language-server/+page.md b/packages/web/src/routes/docs/integrations/language-server/+page.md
index afaa6c696..1928b448e 100644
--- a/packages/web/src/routes/docs/integrations/language-server/+page.md
+++ b/packages/web/src/routes/docs/integrations/language-server/+page.md
@@ -295,6 +295,7 @@ These configs are under the `markdown` key:
| Nix | `nix` | ✅ |
| Org Mode | `org` | |
| PHP | `php` | ✅ |
+| PowerShell | `powershell` | ✅ |
| Plain Text | `plaintext`/`text` | |
| Python | `python` | ✅ |
| Ruby | `ruby` | ✅ |