Skip to content

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

Feature/add asciidoc support (#2407)

Crown0815a0aab09d89bf
diff --git a/Cargo.lock b/Cargo.lock
index 1e4bb7727..3ffa1772e 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2667,6 +2667,17 @@ dependencies = [
"zerocopy",
]
+[[package]]
+name = "harper-asciidoc"
+version = "1.0.0"
+dependencies = [
+ "harper-core",
+ "harper-tree-sitter",
+ "paste",
+ "tree-sitter",
+ "tree-sitter-asciidoc",
+]
+
[[package]]
name = "harper-brill"
version = "1.3.0"
@@ -2684,7 +2695,7 @@ dependencies = [
"ariadne",
"clap",
"dirs 6.0.0",
- "either",
+ "harper-asciidoc",
"harper-comments",
"harper-core",
"harper-ink",
@@ -2698,7 +2709,6 @@ dependencies = [
"serde",
"serde_json",
"strum",
- "strum_macros",
]
[[package]]
@@ -2826,6 +2836,7 @@ dependencies = [
"dirs 6.0.0",
"futures",
"globset",
+ "harper-asciidoc",
"harper-comments",
"harper-core",
"harper-html",
@@ -2835,9 +2846,7 @@ dependencies = [
"harper-python",
"harper-stats",
"harper-typst",
- "indexmap",
"itertools 0.14.0",
- "once_cell",
"open",
"resolve-path",
"serde",
@@ -3252,8 +3261,6 @@ checksum = "0ad4bb2b565bca0645f4d68c5c9af97fba094e9791da685bf83cb5f3ce74acf2"
dependencies = [
"equivalent",
"hashbrown 0.16.1",
- "serde",
- "serde_core",
]
[[package]]
@@ -5749,6 +5756,16 @@ dependencies = [
"tree-sitter-language",
]
+[[package]]
+name = "tree-sitter-asciidoc"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cebb4c0029a4b3942c8cfab42ae38f774855ad4c16fd06ad8e7ad07a8347c616"
+dependencies = [
+ "cc",
+ "tree-sitter",
+]
+
[[package]]
name = "tree-sitter-bash"
version = "0.25.1"
diff --git a/Cargo.toml b/Cargo.toml
index 1ac053674..c2c16795e 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,5 +1,5 @@
[workspace]
-members = ["harper-cli", "harper-core", "harper-ls", "harper-comments", "harper-wasm", "harper-tree-sitter", "harper-html", "harper-literate-haskell", "harper-typst", "harper-stats", "harper-pos-utils", "harper-brill", "harper-ink", "harper-python", "harper-jjdescription", "fuzz"]
+members = ["harper-cli", "harper-core", "harper-ls", "harper-comments", "harper-wasm", "harper-tree-sitter", "harper-html", "harper-literate-haskell", "harper-typst", "harper-stats", "harper-pos-utils", "harper-brill", "harper-ink", "harper-python", "harper-jjdescription", "harper-asciidoc", "fuzz"]
resolver = "2"
[profile.test]
diff --git a/harper-asciidoc/Cargo.toml b/harper-asciidoc/Cargo.toml
new file mode 100644
index 000000000..34a10cfb8
--- /dev/null
+++ b/harper-asciidoc/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "harper-asciidoc"
+version = "1.0.0"
+edition = "2024"
+description = "The language checker for developers."
+license = "Apache-2.0"
+repository = "https://github.com/automattic/harper"
+
+[dependencies]
+harper-core = { path = "../harper-core", version = "1.0.0" }
+harper-tree-sitter = { path = "../harper-tree-sitter", version = "1.0.0" }
+tree-sitter-asciidoc = "0.6.0"
+tree-sitter = "0.25.10"
+
+[dev-dependencies]
+paste = "1.0.15"
diff --git a/harper-asciidoc/src/lib.rs b/harper-asciidoc/src/lib.rs
new file mode 100644
index 000000000..6806fa18e
--- /dev/null
+++ b/harper-asciidoc/src/lib.rs
@@ -0,0 +1,42 @@
+use harper_core::parsers::{self, Parser, PlainEnglish};
+use harper_core::{Token, TokenKind};
+use harper_tree_sitter::TreeSitterMasker;
+use tree_sitter::Node;
+
+pub struct AsciidocParser {
+ inner: parsers::Mask<TreeSitterMasker, PlainEnglish>,
+}
+
+impl AsciidocParser {
+ fn node_condition(n: &Node) -> bool {
+ matches!(
+ n.kind(),
+ "line" | "body" | "table_cell_content" | "author" | "ident_block_line"
+ )
+ }
+}
+
+impl Default for AsciidocParser {
+ fn default() -> Self {
+ Self {
+ inner: parsers::Mask::new(
+ TreeSitterMasker::new(tree_sitter_asciidoc::language(), Self::node_condition),
+ PlainEnglish,
+ ),
+ }
+ }
+}
+
+impl Parser for AsciidocParser {
+ fn parse(&self, source: &[char]) -> Vec<Token> {
+ let mut tokens = self.inner.parse(source);
+
+ for token in &mut tokens {
+ if let TokenKind::Space(v) = &mut token.kind {
+ *v = (*v).clamp(0, 1);
+ }
+ }
+
+ tokens
+ }
+}
diff --git a/harper-asciidoc/tests/asciidoc_tests.rs b/harper-asciidoc/tests/asciidoc_tests.rs
new file mode 100644
index 000000000..7522d4007
--- /dev/null
+++ b/harper-asciidoc/tests/asciidoc_tests.rs
@@ -0,0 +1,42 @@
+use harper_asciidoc::AsciidocParser;
+use harper_core::linting::{LintGroup, Linter};
+use harper_core::spell::FstDictionary;
+use harper_core::{Dialect, Document};
+
+/// Creates a unit test checking Asciidoc source code parsing.
+macro_rules! create_test {
+ ($filename:ident.$ext:ident, $correct_expected:expr) => {
+ paste::paste! {
+ #[test]
+ fn [<lints_$ext _ $filename _correctly>](){
+ let source = include_str!(
+ concat!(
+ "./test_sources/",
+ concat!(
+ stringify!($filename), ".", stringify!($ext))
+ )
+ );
+
+ let parser = AsciidocParser::default();
+ let dict = FstDictionary::curated();
+ let document = Document::new(&source, &parser, &dict);
+
+ let mut linter = LintGroup::new_curated(dict, Dialect::American);
+ let lints = linter.lint(&document);
+
+ dbg!(&lints);
+ assert_eq!(lints.len(), $correct_expected);
+
+ // Make sure that all generated tokens span real characters
+ for token in document.tokens(){
+ assert!(token.span.try_get_content(document.get_source()).is_some());
+ }
+ }
+ }
+ };
+}
+
+create_test!(basic.adoc, 2);
+create_test!(table.adoc, 1);
+create_test!(comment.adoc, 2);
+create_test!(comprehensive.adoc, 13);
diff --git a/harper-asciidoc/tests/test_sources/basic.adoc b/harper-asciidoc/tests/test_sources/basic.adoc
new file mode 100644
index 000000000..19d00d70e
--- /dev/null
+++ b/harper-asciidoc/tests/test_sources/basic.adoc
@@ -0,0 +1,3 @@
+= This is a titlle
+
+This is a basic paragraph with a typo here: mstakes.
diff --git a/harper-asciidoc/tests/test_sources/comment.adoc b/harper-asciidoc/tests/test_sources/comment.adoc
new file mode 100644
index 000000000..52fe8c313
--- /dev/null
+++ b/harper-asciidoc/tests/test_sources/comment.adoc
@@ -0,0 +1,2 @@
+// This is a comment with a typo: spelll
+// Another line of comment.
diff --git a/harper-asciidoc/tests/test_sources/comprehensive.adoc b/harper-asciidoc/tests/test_sources/comprehensive.adoc
new file mode 100644
index 000000000..95b4797d6
--- /dev/null
+++ b/harper-asciidoc/tests/test_sources/comprehensive.adoc
@@ -0,0 +1,35 @@
+= Document Title
+Author Name <[email protected]>
+:revdate: 2026-01-01
+:custom-attr: Value with typpo.
+
+This is a paragraph with a deliberate typpo.
+
+== Section Titlre
+
+* List item with errorr
+* Another item
+
+.Block Titlle
+[NOTE]
+====
+Admonition with mistacke.
+====
+
+|===
+| Header with errorr | Header 2
+
+| Cell with typpo | Cell 1.2
+|===
+
+// Comment with mistacke.
+
+////
+Block comment with errorr.
+////
+
+Indented block:
+ This has a typpo too.
+
+Term with errorr::
+ Definition with mistacke.
diff --git a/harper-asciidoc/tests/test_sources/table.adoc b/harper-asciidoc/tests/test_sources/table.adoc
new file mode 100644
index 000000000..d0ad346dd
--- /dev/null
+++ b/harper-asciidoc/tests/test_sources/table.adoc
@@ -0,0 +1,3 @@
+|===
+| Cell 1 | Cell 2 with typo: errorr
+|===
diff --git a/harper-cli/Cargo.toml b/harper-cli/Cargo.toml
index e02d15d27..6fccd8536 100644
--- a/harper-cli/Cargo.toml
+++ b/harper-cli/Cargo.toml
@@ -13,6 +13,7 @@ harper-stats = { path = "../harper-stats", version = "1.0.0" }
dirs = "6.0.0"
harper-literate-haskell = { path = "../harper-literate-haskell", version = "1.0.0" }
harper-python = { path = "../harper-python", version = "1.0.0" }
+harper-asciidoc = { path = "../harper-asciidoc", version = "1.0.0" }
harper-core = { path = "../harper-core", version = "1.0.0" }
harper-pos-utils = { path = "../harper-pos-utils", version = "1.0.0", features = [] }
harper-comments = { path = "../harper-comments", version = "1.0.0" }
@@ -22,9 +23,7 @@ rayon = "1.11.0"
serde = { version = "1.0.228", features = ["derive"] }
serde_json = "1.0.148"
strum = "0.27.2"
-strum_macros = "0.27.2"
harper-ink = { version = "1.0.0", path = "../harper-ink" }
-either = "1.15.0"
[features]
default = []
diff --git a/harper-cli/src/main.rs b/harper-cli/src/main.rs
index ecf2974ce..81ae7cf13 100644
--- a/harper-cli/src/main.rs
+++ b/harper-cli/src/main.rs
@@ -13,6 +13,7 @@ use anyhow::anyhow;
use ariadne::{Color, Label, Report, ReportKind, Source};
use clap::Parser;
use dirs::{config_dir, data_local_dir};
+use harper_asciidoc::AsciidocParser;
use harper_comments::CommentParser;
use harper_core::linting::LintGroup;
use harper_core::parsers::{Markdown, MarkdownOptions, OrgMode, PlainEnglish};
@@ -946,6 +947,7 @@ fn load_file(
Some("org") => Box::new(OrgMode),
Some("typ") => Box::new(harper_typst::Typst),
Some("py") | Some("pyi") => Box::new(PythonParser::default()),
+ Some("adoc") | Some("asciidoc") => Box::new(AsciidocParser::default()),
Some("txt") => Box::new(PlainEnglish),
_ => {
if let Some(comment_parser) = CommentParser::new_from_filename(file, markdown_options) {
diff --git a/harper-ls/Cargo.toml b/harper-ls/Cargo.toml
index 001579761..115edbd02 100644
--- a/harper-ls/Cargo.toml
+++ b/harper-ls/Cargo.toml
@@ -16,10 +16,10 @@ harper-jjdescription = { path = "../harper-jjdescription", version = "1.0.0" }
harper-typst = { path = "../harper-typst", version = "1.0.0" }
harper-html = { path = "../harper-html", version = "1.0.0" }
harper-python = { path = "../harper-python", version = "1.0.0" }
+harper-asciidoc = { path = "../harper-asciidoc", version = "1.0.0" }
tower-lsp-server = "0.22.1"
tokio = { version = "1.48.0", default-features = false, features = ["fs", "io-std", "io-util", "macros", "net", "rt-multi-thread", "sync"] }
clap = { version = "4.5.53", default-features = false, features = ["derive", "std"] }
-once_cell = "1.21.3"
dirs = "6.0.0"
anyhow = "1.0.100"
serde_json = "1.0.148"
@@ -30,7 +30,6 @@ resolve-path = "0.1.0"
open = "5.3.3"
futures = "0.3.31"
serde = { version = "1.0.228", features = ["derive"] }
-indexmap = { version = "2.12.1", features = ["serde"] }
globset = "0.4.18"
harper-ink = { version = "1.0.0", path = "../harper-ink" }
diff --git a/harper-ls/src/backend.rs b/harper-ls/src/backend.rs
index 83a06adba..eff28e758 100644
--- a/harper-ls/src/backend.rs
+++ b/harper-ls/src/backend.rs
@@ -12,6 +12,7 @@ use crate::ignored_lints_io::{load_ignored_lints, save_ignored_lints};
use crate::io_utils::fileify_path;
use anyhow::{Context, Result, anyhow};
use futures::future::join;
+use harper_asciidoc::AsciidocParser;
use harper_comments::CommentParser;
use harper_core::linting::{LintGroup, LintGroupConfig};
use harper_core::parsers::{
@@ -363,6 +364,7 @@ impl Backend {
Some(Box::new(GitCommitParser::new_markdown(markdown_options)))
}
"html" => Some(Box::new(HtmlParser::default())),
+ "asciidoc" => Some(Box::new(AsciidocParser::default())),
"ink" => Some(Box::new(InkParser::default())),
"jj-commit" | "jjdescription" => {
Some(Box::new(JJDescriptionParser::new(markdown_options)))