Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat: created lint for boring language
Elijah Potter9f36d0081822
diff --git a/harper-core/src/linting/boring_words.rs b/harper-core/src/linting/boring_words.rsnew file mode 100644index 000000000..5f187dc1c--- /dev/null+++ b/harper-core/src/linting/boring_words.rs@@ -0,0 +1,44 @@+use crate::{+ patterns::{Pattern, WordPatternGroup},+ Token, TokenStringExt,+};++use super::{Lint, LintKind, PatternLinter};++pub struct BoringWords {+ pattern: Box<dyn Pattern>,+}++impl Default for BoringWords {+ fn default() -> Self {+ let mut pattern = WordPatternGroup::default();++ pattern.add_word("very");+ pattern.add_word("interesting");++ Self {+ pattern: Box::new(pattern),+ }+ }+}++impl PatternLinter for BoringWords {+ fn pattern(&self) -> &dyn Pattern {+ self.pattern.as_ref()+ }++ fn match_to_lint(&self, matched_tokens: &[Token], source: &[char]) -> Lint {+ let matched_word = matched_tokens.span().unwrap().get_content_string(source);++ Lint {+ span: matched_tokens.span().unwrap(),+ lint_kind: LintKind::Enhancement,+ suggestions: vec![],+ message: format!(+ "“{}” is a boring word. Try something a little more exotic.",+ matched_word+ ),+ priority: 127,+ }+ }+}diff --git a/harper-core/src/linting/lint.rs b/harper-core/src/linting/lint.rsindex e4053181b..4ee8363f9 100644--- a/harper-core/src/linting/lint.rs+++ b/harper-core/src/linting/lint.rs@@ -34,6 +34,7 @@ pub enum LintKind {Capitalization,Formatting,Repetition,+ Enhancement,Readability,#[default]Miscellaneous,@@ -48,6 +49,7 @@ impl Display for LintKind {LintKind::Repetition => "Repetition",LintKind::Readability => "Readability",LintKind::Miscellaneous => "Miscellaneous",+ LintKind::Enhancement => "Enhancement",};write!(f, "{}", s)diff --git a/harper-core/src/linting/lint_group.rs b/harper-core/src/linting/lint_group.rsindex b68e70b09..fbbc79f79 100644--- a/harper-core/src/linting/lint_group.rs+++ b/harper-core/src/linting/lint_group.rs@@ -3,6 +3,7 @@ use serde::{Deserialize, Serialize};use super::an_a::AnA;use super::avoid_curses::AvoidCurses;+use super::boring_words::BoringWords;use super::correct_number_suffix::CorrectNumberSuffix;use super::dot_initialisms::DotInitialisms;use super::ellipsis_length::EllipsisLength;@@ -125,7 +126,8 @@ create_lint_group_config!(AvoidCurses => true,TerminatingConjunctions => true,EllipsisLength => true,- DotInitialisms => true+ DotInitialisms => true,+ BoringWords => false);impl<T: Dictionary + Default> Default for LintGroup<T> {diff --git a/harper-core/src/linting/mod.rs b/harper-core/src/linting/mod.rsindex 49275f5f3..78f74039a 100644--- a/harper-core/src/linting/mod.rs+++ b/harper-core/src/linting/mod.rs@@ -1,5 +1,6 @@mod an_a;mod avoid_curses;+mod boring_words;mod correct_number_suffix;mod dot_initialisms;mod ellipsis_length;@@ -22,6 +23,7 @@ mod wrong_quotes;pub use an_a::AnA;pub use avoid_curses::AvoidCurses;+pub use boring_words::BoringWords;pub use correct_number_suffix::CorrectNumberSuffix;pub use dot_initialisms::DotInitialisms;pub use ellipsis_length::EllipsisLength;diff --git a/harper-core/src/patterns/word_pattern_group.rs b/harper-core/src/patterns/word_pattern_group.rsindex 8afd6fa8f..15b3fa85f 100644--- a/harper-core/src/patterns/word_pattern_group.rs+++ b/harper-core/src/patterns/word_pattern_group.rs@@ -1,7 +1,7 @@use hashbrown::HashMap;use super::naive_pattern_group::NaivePatternGroup;-use super::Pattern;+use super::{Pattern, SequencePattern};use crate::CharString;/// A pattern collection to look for patterns that start with a specific@@ -26,6 +26,14 @@ impl WordPatternGroup<NaivePatternGroup> {self.patterns.insert(chars, group);}}++ /// Add a pattern that matches just a word on its own, without anything else required to match.+ pub fn add_word(&mut self, word: &'static str) {+ self.add(+ word,+ Box::new(SequencePattern::default().then_exact_word(word)),+ );+ }}impl<P> Pattern for WordPatternGroup<P>