Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat: renamed `harper-tree-sitter` -> `harper-comments`
Elijah Potter1c69cb026274
diff --git a/Cargo.lock b/Cargo.lockindex 105af732e..33cbac155 100644--- a/Cargo.lock+++ b/Cargo.lock@@ -549,8 +549,29 @@ dependencies = ["anyhow","ariadne","clap",+ "harper-comments","harper-core",- "harper-tree-sitter",+]++[[package]]+name = "harper-comments"+version = "0.8.0"+dependencies = [+ "harper-core",+ "paste",+ "tree-sitter",+ "tree-sitter-c",+ "tree-sitter-c-sharp",+ "tree-sitter-cpp",+ "tree-sitter-go",+ "tree-sitter-javascript",+ "tree-sitter-lua",+ "tree-sitter-python",+ "tree-sitter-ruby",+ "tree-sitter-rust",+ "tree-sitter-swift",+ "tree-sitter-toml",+ "tree-sitter-typescript",][[package]]@@ -581,8 +602,8 @@ dependencies = ["clap","dirs 5.0.1","futures",+ "harper-comments","harper-core",- "harper-tree-sitter","itertools","once_cell","open",@@ -609,27 +630,6 @@ dependencies = ["tracing-subscriber",]-[[package]]-name = "harper-tree-sitter"-version = "0.8.0"-dependencies = [- "harper-core",- "paste",- "tree-sitter",- "tree-sitter-c",- "tree-sitter-c-sharp",- "tree-sitter-cpp",- "tree-sitter-go",- "tree-sitter-javascript",- "tree-sitter-lua",- "tree-sitter-python",- "tree-sitter-ruby",- "tree-sitter-rust",- "tree-sitter-swift",- "tree-sitter-toml",- "tree-sitter-typescript",-]-[[package]]name = "harper-wasm"version = "0.1.0"diff --git a/Cargo.toml b/Cargo.tomlindex 8f96b4f11..60580af34 100644--- a/Cargo.toml+++ b/Cargo.toml@@ -1,5 +1,5 @@[workspace]-members = [ "harper-cli", "harper-core", "harper-ls", "harper-serve", "harper-tree-sitter", "harper-wasm"]+members = [ "harper-cli", "harper-core", "harper-ls", "harper-serve", "harper-comments", "harper-wasm"]resolver = "2"[profile.release]diff --git a/harper-cli/Cargo.toml b/harper-cli/Cargo.tomlindex 9cf661cfc..58b829928 100644--- a/harper-cli/Cargo.toml+++ b/harper-cli/Cargo.toml@@ -11,4 +11,4 @@ anyhow = "1.0.83"ariadne = "0.4.1"clap = { version = "4.5.4", features = ["derive"] }harper-core = { path = "../harper-core", version = "0.8.0" }-harper-tree-sitter = { path = "../harper-tree-sitter", version = "0.8.0" }+harper-comments = { path = "../harper-comments", version = "0.8.0" }diff --git a/harper-cli/src/main.rs b/harper-cli/src/main.rsindex 7705f4d1c..5cbddd915 100644--- a/harper-cli/src/main.rs+++ b/harper-cli/src/main.rs@@ -3,8 +3,8 @@ use std::path::{Path, PathBuf};use anyhow::format_err;use ariadne::{Color, Label, Report, ReportKind, Source};use clap::Parser;+use harper_comments::TreeSitterParser;use harper_core::{remove_overlaps, Document, FullDictionary, LintGroup, LintGroupConfig, Linter};-use harper_tree_sitter::TreeSitterParser;#[derive(Debug, Parser)]enum Args {diff --git a/harper-tree-sitter/Cargo.toml b/harper-comments/Cargo.tomlsimilarity index 94%rename from harper-tree-sitter/Cargo.tomlrename to harper-comments/Cargo.tomlindex 3406eb547..84e7b352b 100644--- a/harper-tree-sitter/Cargo.toml+++ b/harper-comments/Cargo.toml@@ -1,5 +1,5 @@[package]-name = "harper-tree-sitter"+name = "harper-comments"version = "0.8.0"edition = "2021"diff --git a/harper-comments/README.md b/harper-comments/README.mdnew file mode 100644index 000000000..31376a038--- /dev/null+++ b/harper-comments/README.md@@ -0,0 +1,5 @@+# `harper-comments`++This crate holds a number of functions, but it is primarily a wrapper around `tree-sitter` that allows Harper to locate the comments of a wide variety of programming languages.+It also has purpose-built parsers for the structured comments of a number of languages, including Go.+These additional parsers are avaiable through the `TreeSitterParser` and are enabled automatically through there.diff --git a/harper-tree-sitter/src/comment_parsers/go.rs b/harper-comments/src/comment_parsers/go.rssimilarity index 100%rename from harper-tree-sitter/src/comment_parsers/go.rsrename to harper-comments/src/comment_parsers/go.rsdiff --git a/harper-tree-sitter/src/comment_parsers/mod.rs b/harper-comments/src/comment_parsers/mod.rssimilarity index 100%rename from harper-tree-sitter/src/comment_parsers/mod.rsrename to harper-comments/src/comment_parsers/mod.rsdiff --git a/harper-tree-sitter/src/comment_parsers/unit.rs b/harper-comments/src/comment_parsers/unit.rssimilarity index 100%rename from harper-tree-sitter/src/comment_parsers/unit.rsrename to harper-comments/src/comment_parsers/unit.rsdiff --git a/harper-tree-sitter/src/lib.rs b/harper-comments/src/lib.rssimilarity index 100%rename from harper-tree-sitter/src/lib.rsrename to harper-comments/src/lib.rsdiff --git a/harper-tree-sitter/src/tree_sitter_parser.rs b/harper-comments/src/tree_sitter_parser.rssimilarity index 100%rename from harper-tree-sitter/src/tree_sitter_parser.rsrename to harper-comments/src/tree_sitter_parser.rsdiff --git a/harper-tree-sitter/tests/language_support.rs b/harper-comments/tests/language_support.rssimilarity index 97%rename from harper-tree-sitter/tests/language_support.rsrename to harper-comments/tests/language_support.rsindex b31f0a078..7ed44b270 100644--- a/harper-tree-sitter/tests/language_support.rs+++ b/harper-comments/tests/language_support.rs@@ -1,7 +1,7 @@use std::path::Path;+use harper_comments::TreeSitterParser;use harper_core::{Document, FullDictionary, LintGroup, LintGroupConfig, Linter};-use harper_tree_sitter::TreeSitterParser;/// Creates a unit test checking that the linting of a source file in/// `language_support_sources` produces the expected number of lints.diff --git a/harper-tree-sitter/tests/language_support_sources/clean.rs b/harper-comments/tests/language_support_sources/clean.rssimilarity index 100%rename from harper-tree-sitter/tests/language_support_sources/clean.rsrename to harper-comments/tests/language_support_sources/clean.rsdiff --git a/harper-tree-sitter/tests/language_support_sources/multiline_comments.cpp b/harper-comments/tests/language_support_sources/multiline_comments.cppsimilarity index 100%rename from harper-tree-sitter/tests/language_support_sources/multiline_comments.cpprename to harper-comments/tests/language_support_sources/multiline_comments.cppdiff --git a/harper-tree-sitter/tests/language_support_sources/multiline_comments.ts b/harper-comments/tests/language_support_sources/multiline_comments.tssimilarity index 100%rename from harper-tree-sitter/tests/language_support_sources/multiline_comments.tsrename to harper-comments/tests/language_support_sources/multiline_comments.tsdiff --git a/harper-ls/Cargo.toml b/harper-ls/Cargo.tomlindex af3be7e05..ca5e012e3 100644--- a/harper-ls/Cargo.toml+++ b/harper-ls/Cargo.toml@@ -9,7 +9,7 @@ repository = "https://github.com/elijah-potter/harper"[dependencies]harper-core = { path = "../harper-core", version = "0.8.0" }-harper-tree-sitter = { path = "../harper-tree-sitter", version = "0.8.0" }+harper-comments = { path = "../harper-comments", version = "0.8.0" }tower-lsp = "0.20.0"tokio = { version = "1.36.0", features = ["fs", "rt", "rt-multi-thread", "macros", "io-std", "io-util", "net"] }clap = { version = "4.5.1", features = ["derive"] }diff --git a/harper-ls/src/backend.rs b/harper-ls/src/backend.rsindex 0c7e968fc..bc16cf53d 100644--- a/harper-ls/src/backend.rs+++ b/harper-ls/src/backend.rs@@ -2,6 +2,7 @@ use std::collections::HashMap;use std::path::{Component, PathBuf};use std::sync::Arc;+use harper_comments::TreeSitterParser;use harper_core::parsers::{Markdown, PlainEnglish};use harper_core::{Dictionary,@@ -13,7 +14,6 @@ use harper_core::{Token,TokenKind};-use harper_tree_sitter::TreeSitterParser;use serde_json::Value;use tokio::sync::{Mutex, RwLock};use tower_lsp::jsonrpc::Result;diff --git a/harper-tree-sitter/README.md b/harper-tree-sitter/README.mddeleted file mode 100644index a2664c8d5..000000000--- a/harper-tree-sitter/README.md+++ /dev/null@@ -1,3 +0,0 @@-# `harper-tree-sitter`--This crate is a wrapper around `tree-sitter` that allows Harper to parse the comments of a wide variety of programming languages.