Skip to content

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

Add Elixir as a supported language (#3934)

jaller698fedc51e8daf8
diff --git a/Cargo.lock b/Cargo.lock
index 40d3fbe5e..e0133306c 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -4233,6 +4233,7 @@ dependencies = [
"tree-sitter-clojure",
"tree-sitter-cmake",
"tree-sitter-cpp",
+ "tree-sitter-elixir",
"tree-sitter-gleam",
"tree-sitter-go",
"tree-sitter-groovy",
@@ -9710,6 +9711,16 @@ dependencies = [
"tree-sitter-language",
]
+[[package]]
+name = "tree-sitter-elixir"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "66dd064a762ed95bfc29857fa3cb7403bb1e5cb88112de0f6341b7e47284ba40"
+dependencies = [
+ "cc",
+ "tree-sitter-language",
+]
+
[[package]]
name = "tree-sitter-gitcommit"
version = "0.5.0"
diff --git a/fuzz/fuzz_targets/fuzz_harper_comment.rs b/fuzz/fuzz_targets/fuzz_harper_comment.rs
index 6d8d42ebf..9a7790554 100644
--- a/fuzz/fuzz_targets/fuzz_harper_comment.rs
+++ b/fuzz/fuzz_targets/fuzz_harper_comment.rs
@@ -7,12 +7,13 @@ use libfuzzer_sys::fuzz_target;
#[derive(Debug)]
struct Language(String);
-const LANGUAGES: [&str; 34] = [
+const LANGUAGES: [&str; 35] = [
"cmake",
"cpp",
"csharp",
"c",
"dart",
+ "elixir",
"go",
"haskell",
"javascriptreact",
diff --git a/harper-comments/Cargo.toml b/harper-comments/Cargo.toml
index 98ac0c455..46cf6cf82 100644
--- a/harper-comments/Cargo.toml
+++ b/harper-comments/Cargo.toml
@@ -18,6 +18,7 @@ tree-sitter-c = "0.24.2"
tree-sitter-cmake = "0.7.1"
tree-sitter-cpp = "0.23.4"
tree-sitter-c-sharp = "0.23.5"
+tree-sitter-elixir = "0.3.5"
tree-sitter-go = "0.25.0"
tree-sitter-groovy = "0.1.2"
tree-sitter-haskell = "0.23.1"
diff --git a/harper-comments/src/comment_parser.rs b/harper-comments/src/comment_parser.rs
index 8747a8493..1541f2721 100644
--- a/harper-comments/src/comment_parser.rs
+++ b/harper-comments/src/comment_parser.rs
@@ -30,6 +30,7 @@ impl CommentParser {
"csharp" => tree_sitter_c_sharp::LANGUAGE,
"dart" => harper_tree_sitter_dart::LANGUAGE,
"gleam" => tree_sitter_gleam::LANGUAGE,
+ "elixir" => tree_sitter_elixir::LANGUAGE,
"go" => tree_sitter_go::LANGUAGE,
"groovy" => tree_sitter_groovy::LANGUAGE,
"haskell" => tree_sitter_haskell::LANGUAGE,
@@ -93,6 +94,7 @@ impl CommentParser {
"cs" => "csharp",
"dart" => "dart",
"gleam" => "gleam",
+ "ex" | "exs" => "elixir",
"go" => "go",
"groovy" | "gradle" => "groovy",
"hs" => "haskell",
diff --git a/harper-comments/tests/language_support.rs b/harper-comments/tests/language_support.rs
index a123869f7..ce8e39f44 100644
--- a/harper-comments/tests/language_support.rs
+++ b/harper-comments/tests/language_support.rs
@@ -51,6 +51,8 @@ create_test!(clean.sol, 0);
create_test!(clean.ps1, 0);
create_test!(clean.gleam, 0);
create_test!(dirty.gleam, 3);
+create_test!(clean.exs, 0);
+create_test!(dirty.exs, 4);
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.exs b/harper-comments/tests/language_support_sources/clean.exs
new file mode 100644
index 000000000..a637081a6
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/clean.exs
@@ -0,0 +1,33 @@
+defmodule MyApp.MixProject do
+ use Mix.Project
+
+ def project do
+ [
+ # Your app's atom name
+ app: :my_app,
+ # Version string
+ version: "0.1.0",
+ # Required Elixir version
+ elixir: "~> 1.14",
+ start_permanent: Mix.env() == :prod,
+ # Dependencies (see below)
+ deps: deps()
+ ]
+ end
+
+ # When building an elixir project, the application function is used to define
+ # the application configuration. It specifies which applications should be
+ # started automatically when your application starts.
+
+ def application do
+ [
+ # Apps to start automatically (e.g., :logger)
+ extra_applications: [:logger]
+ ]
+ end
+
+ defp some_function do
+ # Some function implementation
+ :ok
+ end
+end
diff --git a/harper-comments/tests/language_support_sources/dirty.exs b/harper-comments/tests/language_support_sources/dirty.exs
new file mode 100644
index 000000000..daee11fa0
--- /dev/null
+++ b/harper-comments/tests/language_support_sources/dirty.exs
@@ -0,0 +1,21 @@
+defmodule MyApp.MixProject do
+ @moduledoc """
+ Note: Spelling mistakes in the module doc and documentation are not picked up by Harper, as they are defined as quoted strings by the tree-sitter.
+
+ This module defin the Mix project configuration for something
+ """
+ use Mix.Project
+
+ def application do
+ [
+ extra_applications: [:logger]
+ ]
+ end
+
+ # Specifies project dependences
+ defp deps do
+ [
+ # Example: {:jason, "~> 1.4"}
+ ]
+ end
+end
diff --git a/packages/vscode-plugin/package.json b/packages/vscode-plugin/package.json
index ea7922ed0..7a9f0e87b 100644
--- a/packages/vscode-plugin/package.json
+++ b/packages/vscode-plugin/package.json
@@ -38,6 +38,7 @@
"onLanguage:cpp",
"onLanguage:csharp",
"onLanguage:dart",
+ "onLanguage:elixir",
"onLanguage:git-commit",
"onLanguage:gleam",
"onLanguage:go",
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 2e72db9b7..8fbd75ffb 100644
--- a/packages/web/src/routes/docs/integrations/language-server/+page.md
+++ b/packages/web/src/routes/docs/integrations/language-server/+page.md
@@ -282,6 +282,7 @@ These configs are under the `markdown` key:
| C# | `csharp` | ✅ |
| DAML | `daml` | ✅ |
| Dart | `dart` | ✅ |
+| Elixir | `elixir` | ✅ |
| Git Commit | `git-commit`/`gitcommit` | |
| Gleam | `gleam` | ✅ |
| Go | `go` | ✅ |