Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
refactor(#825): move to wrapping masker instead of masking in harper-tree-sitter
Grant Lemons0bb4ead8ca05
diff --git a/harper-comments/src/comment_parser.rs b/harper-comments/src/comment_parser.rsindex a72e722e6..0e66d063b 100644--- a/harper-comments/src/comment_parser.rs+++ b/harper-comments/src/comment_parser.rs@@ -3,13 +3,13 @@ use std::path::Path;use comment_parsers::{Go, JavaDoc, JsDoc, Unit};use harper_core::parsers::{self, MarkdownOptions, Parser};use harper_core::{MutableDictionary, Token};-use harper_tree_sitter::TreeSitterMasker;use tree_sitter::Node;use crate::comment_parsers;+use crate::masker::CommentMasker;pub struct CommentParser {- inner: parsers::Mask<TreeSitterMasker, Box<dyn Parser>>,+ inner: parsers::Mask<CommentMasker, Box<dyn Parser>>,}impl CommentParser {@@ -57,7 +57,7 @@ impl CommentParser {Some(Self {inner: parsers::Mask::new(- TreeSitterMasker::new(language, Self::node_condition),+ CommentMasker::new(language, Self::node_condition),comment_parser,),})diff --git a/harper-comments/src/lib.rs b/harper-comments/src/lib.rsindex 069671660..a2e4cbb08 100644--- a/harper-comments/src/lib.rs+++ b/harper-comments/src/lib.rs@@ -2,4 +2,5 @@mod comment_parser;mod comment_parsers;+mod masker;pub use comment_parser::CommentParser;diff --git a/harper-comments/src/masker.rs b/harper-comments/src/masker.rsnew file mode 100644index 000000000..8f51976ce--- /dev/null+++ b/harper-comments/src/masker.rs@@ -0,0 +1,56 @@+use harper_core::{Masker, MutableDictionary};+use harper_tree_sitter::TreeSitterMasker;++pub struct CommentMasker {+ inner: TreeSitterMasker,+ ignore_condition: Box<dyn Fn(&String) -> bool + Send + Sync>,+}++impl CommentMasker {+ pub fn create_ident_dict(&self, source: &[char]) -> Option<MutableDictionary> {+ self.inner.create_ident_dict(source)+ }++ pub fn new(+ language: tree_sitter::Language,+ ts_node_condition: fn(&tree_sitter::Node) -> bool,+ ) -> Self {+ Self::new_with_ignore_condition(+ language,+ ts_node_condition,+ Box::new(|text| {+ text.contains("spellchecker:ignore")+ || text.contains("spellchecker: ignore")+ || text.contains("spellcheck:ignore")+ || text.contains("spellcheck: ignore")+ || text.contains("cspell:ignore")+ || text.contains("cspell: ignore")+ || text.contains("harper:ignore")+ || text.contains("harper: ignore")+ }),+ )+ }++ pub fn new_with_ignore_condition(+ language: tree_sitter::Language,+ ts_node_condition: fn(&tree_sitter::Node) -> bool,+ ignore_condition: Box<dyn Fn(&String) -> bool + Send + Sync>,+ ) -> Self {+ Self {+ inner: TreeSitterMasker::new(language, ts_node_condition),+ ignore_condition,+ }+ }+}++impl Masker for CommentMasker {+ fn create_mask(&self, source: &[char]) -> harper_core::Mask {+ self.inner+ .create_mask(source)+ .iter_allowed(source)+ .map(|(span, chars)| (span, chars.iter().collect::<String>()))+ .filter(|(_, text)| !(self.ignore_condition)(text))+ .map(|(span, _)| span)+ .collect()+ }+}diff --git a/harper-core/src/mask/mod.rs b/harper-core/src/mask/mod.rsindex c633d6c69..3c0cf98e9 100644--- a/harper-core/src/mask/mod.rs+++ b/harper-core/src/mask/mod.rs@@ -1,3 +1,5 @@+use itertools::Itertools;+use crate::Span;/// A Masker is a tool that can be composed to eliminate chunks of text from@@ -20,6 +22,20 @@ pub struct Mask {pub(self) allowed: Vec<Span>,}+impl FromIterator<Span> for Mask {+ fn from_iter<T: IntoIterator<Item = Span>>(iter: T) -> Self {+ let spans = iter.into_iter().sorted_by_key(|span| span.start);+ assert!(+ spans.clone().tuple_windows().all(|(a, b)| b.start >= a.end),+ "Masker elements cannot overlap and must be sorted!"+ );++ Self {+ allowed: spans.collect(),+ }+ }+}+impl Mask {/// Create a new Mask for a given piece of text, marking all text as/// disallowed.@@ -39,7 +55,10 @@ impl Mask {/// Mark a span of the text as allowed.pub fn push_allowed(&mut self, allowed: Span) {if let Some(last) = self.allowed.last_mut() {- assert!(allowed.start >= last.end);+ assert!(+ allowed.start >= last.end,+ "Masker elements cannot overlap and must be sorted!"+ );if allowed.start == last.end {last.end = allowed.end;diff --git a/harper-tree-sitter/src/lib.rs b/harper-tree-sitter/src/lib.rsindex 5bca68a5a..8e3516970 100644--- a/harper-tree-sitter/src/lib.rs+++ b/harper-tree-sitter/src/lib.rs@@ -106,10 +106,7 @@ impl Masker for TreeSitterMasker {let mut mask = Mask::new_blank();for span in comments_spans {- let text = span.get_content_string(source);- if !(text.contains("spellchecker:ignore") || text.contains("spellchecker: ignore")) {- mask.push_allowed(span);- }+ mask.push_allowed(span);}mask.merge_whitespace_sep(source);