Skip to content

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

feat(comments): add support for `gleam` (#3754)

Elijah Potter95334519170d
diff --git a/Cargo.lock b/Cargo.lock
index 7caf99235..f44dc9e9c 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -4227,6 +4227,7 @@ dependencies = [
"tree-sitter-clojure",
"tree-sitter-cmake",
"tree-sitter-cpp",
+ "tree-sitter-gleam",
"tree-sitter-go",
"tree-sitter-groovy",
"tree-sitter-haskell",
@@ -9713,6 +9714,16 @@ dependencies = [
"tree-sitter-language",
]
+[[package]]
+name = "tree-sitter-gleam"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0175c53793bda5d444360dd5add25463d18d66afb7f521d6791e2fc61bf2fb3"
+dependencies = [
+ "cc",
+ "tree-sitter-language",
+]
+
[[package]]
name = "tree-sitter-go"
version = "0.25.0"
diff --git a/harper-comments/Cargo.toml b/harper-comments/Cargo.toml
index 852331b22..989da3890 100644
--- a/harper-comments/Cargo.toml
+++ b/harper-comments/Cargo.toml
@@ -38,6 +38,7 @@ 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"
+tree-sitter-gleam = "1.0.0"
[dev-dependencies]
paste = "1.0.15"
diff --git a/harper-comments/src/comment_parser.rs b/harper-comments/src/comment_parser.rs
index 077120162..8747a8493 100644
--- a/harper-comments/src/comment_parser.rs
+++ b/harper-comments/src/comment_parser.rs
@@ -29,6 +29,7 @@ impl CommentParser {
"cpp" => tree_sitter_cpp::LANGUAGE,
"csharp" => tree_sitter_c_sharp::LANGUAGE,
"dart" => harper_tree_sitter_dart::LANGUAGE,
+ "gleam" => tree_sitter_gleam::LANGUAGE,
"go" => tree_sitter_go::LANGUAGE,
"groovy" => tree_sitter_groovy::LANGUAGE,
"haskell" => tree_sitter_haskell::LANGUAGE,
@@ -91,6 +92,7 @@ impl CommentParser {
"cpp" | "h" => "cpp",
"cs" => "csharp",
"dart" => "dart",
+ "gleam" => "gleam",
"go" => "go",
"groovy" | "gradle" => "groovy",
"hs" => "haskell",
diff --git a/harper-comments/tests/language_support.rs b/harper-comments/tests/language_support.rs
index f475eb26d..a123869f7 100644
--- a/harper-comments/tests/language_support.rs
+++ b/harper-comments/tests/language_support.rs
@@ -49,6 +49,8 @@ create_test!(dirty.lua, 1);
create_test!(clean.rs, 0);
create_test!(clean.sol, 0);
create_test!(clean.ps1, 0);
+create_test!(clean.gleam, 0);
+create_test!(dirty.gleam, 3);
create_test!(jsdoc.ts, 4);
create_test!(issue_96.lua, 0);
create_test!(merged_lines.ts, 1);
diff --git a/harper-comments/tests/language_support_sources/clean.gleam b/harper-comments/tests/language_support_sources/clean.gleam
new file mode 100644
index 000000000..74114b9ae
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/clean.gleam
@@ -0,0 +1,14 @@
+//// Clean comments.
+
+import gleam/io
+
+/// Print a friendly message.
+pub fn main() {
+ // Keep the output simple.
+ io.println("Errorz should be ignored inside strings")
+}
+
+/// Add two numbers.
+pub fn add(left: Int, right: Int) -> Int {
+ left + right
+}
diff --git a/harper-comments/tests/language_support_sources/dirty.gleam b/harper-comments/tests/language_support_sources/dirty.gleam
new file mode 100644
index 000000000..f6aaae94e
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/dirty.gleam
@@ -0,0 +1,9 @@
+//// This module comment has Errorz.
+
+import gleam/io
+
+/// This function comment has Errorz.
+pub fn main() {
+ // This regular comment has Errorz.
+ io.println("Errorz should be ignored inside strings")
+}
diff --git a/packages/vscode-plugin/package.json b/packages/vscode-plugin/package.json
index 923e39f41..1426dd1a4 100644
--- a/packages/vscode-plugin/package.json
+++ b/packages/vscode-plugin/package.json
@@ -39,6 +39,7 @@
"onLanguage:csharp",
"onLanguage:dart",
"onLanguage:git-commit",
+ "onLanguage:gleam",
"onLanguage:go",
"onLanguage:groovy",
"onLanguage:haskell",
@@ -85,6 +86,18 @@
}
}
},
+ "languages": [
+ {
+ "id": "gleam",
+ "aliases": [
+ "Gleam",
+ "gleam"
+ ],
+ "extensions": [
+ ".gleam"
+ ]
+ }
+ ],
"commands": [
{
"command": "harper.languageserver.restart",
diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/gleam.gleam b/packages/vscode-plugin/src/tests/fixtures/languages/gleam.gleam
new file mode 100644
index 000000000..d182264c9
--- /dev/null
+++ b/packages/vscode-plugin/src/tests/fixtures/languages/gleam.gleam
@@ -0,0 +1,5 @@
+// Errorz
+pub fn main() {
+ let text = "Errorz should be ignored inside strings"
+ text
+}
diff --git a/packages/vscode-plugin/src/tests/suite/languages.test.ts b/packages/vscode-plugin/src/tests/suite/languages.test.ts
index 816561e92..4af12b112 100644
--- a/packages/vscode-plugin/src/tests/suite/languages.test.ts
+++ b/packages/vscode-plugin/src/tests/suite/languages.test.ts
@@ -32,6 +32,7 @@ describe('Languages >', () => {
{ type: 'C#', file: 'csharp.cs', row: 2, column: 2 },
{ type: 'Dart', file: 'dart.dart', row: 1, column: 29 },
{ type: 'Git Commit', file: 'git-commit', row: 0, column: 0 },
+ { type: 'Gleam', file: 'gleam.gleam', row: 0, column: 3 },
{ type: 'Go', file: 'go.go', row: 4, column: 4 },
{ type: 'Groovy', file: 'groovy.groovy', row: 0, column: 3 },
{ type: 'HTML', file: 'html.html', row: 8, column: 6 },
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 2b8621193..2e72db9b7 100644
--- a/packages/web/src/routes/docs/integrations/language-server/+page.md
+++ b/packages/web/src/routes/docs/integrations/language-server/+page.md
@@ -283,6 +283,7 @@ These configs are under the `markdown` key:
| DAML | `daml` | ✅ |
| Dart | `dart` | ✅ |
| Git Commit | `git-commit`/`gitcommit` | |
+| Gleam | `gleam` | ✅ |
| Go | `go` | ✅ |
| Groovy | `groovy` | ✅ |
| Haskell | `haskell` | ✅ |