Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat: the point for→the point of (#2834)
Andrew Dunbard7f08e5c74b1
diff --git a/harper-core/src/linting/lint_group.rs b/harper-core/src/linting/lint_group.rsindex 66ab70e52..a1fcc3bfd 100644--- a/harper-core/src/linting/lint_group.rs+++ b/harper-core/src/linting/lint_group.rs@@ -197,6 +197,7 @@ use super::that_than::ThatThan;use super::that_which::ThatWhich;use super::the_how_why::TheHowWhy;use super::the_my::TheMy;+use super::the_point_for::ThePointFor;use super::the_proper_noun_possessive::TheProperNounPossessive;use super::then_than::ThenThan;use super::theres::Theres;@@ -595,6 +596,7 @@ impl LintGroup {insert_expr_rule!(ThatWhich, true);insert_expr_rule!(TheHowWhy, true);insert_expr_rule!(TheMy, true);+ insert_expr_rule!(ThePointFor, true);insert_expr_rule!(TheProperNounPossessive, true);insert_expr_rule!(ThenThan, true);insert_expr_rule!(Theres, true);diff --git a/harper-core/src/linting/mod.rs b/harper-core/src/linting/mod.rsindex 9c5f84f39..c3096c71c 100644--- a/harper-core/src/linting/mod.rs+++ b/harper-core/src/linting/mod.rs@@ -208,6 +208,7 @@ mod that_than;mod that_which;mod the_how_why;mod the_my;+mod the_point_for;mod the_proper_noun_possessive;mod then_than;mod theres;@@ -284,6 +285,7 @@ where}}+#[cfg(test)]pub mod tests {use crate::parsers::Markdown;use crate::{Document, Span, Token};diff --git a/harper-core/src/linting/the_point_for.rs b/harper-core/src/linting/the_point_for.rsnew file mode 100644index 000000000..a82ec057f--- /dev/null+++ b/harper-core/src/linting/the_point_for.rs@@ -0,0 +1,133 @@+use crate::{+ CharStringExt, Lint, Token,+ expr::{Expr, SequenceExpr},+ linting::{ExprLinter, LintKind, Suggestion, expr_linter::Chunk},+ patterns::WordSet,+};++pub struct ThePointFor {+ expr: Box<dyn Expr>,+}++impl Default for ThePointFor {+ fn default() -> Self {+ Self {+ expr: Box::new(+ SequenceExpr::any_of(vec![Box::new(WordSet::new(&[+ // "that's" leads to false positives: "that's the point for me"+ "is", "was", "what's", "whats",+ ]))])+ .t_ws()+ .t_aco("the")+ .t_ws()+ .t_aco("point")+ .t_ws()+ .t_aco("for"),+ ),+ }+ }+}++impl ExprLinter for ThePointFor {+ type Unit = Chunk;++ fn description(&self) -> &str {+ "Corrects `the point for` to `the point of`"+ }++ fn expr(&self) -> &dyn Expr {+ self.expr.as_ref()+ }++ fn match_to_lint_with_context(+ &self,+ toks: &[Token],+ src: &[char],+ ctx: Option<(&[Token], &[Token])>,+ ) -> Option<Lint> {+ // Avoid flagging things like "p0 is the point for which we want to find the closest point to the line"+ if let Some((_, after)) = ctx+ && after.len() >= 2+ && after[0].kind.is_whitespace()+ && after[1]+ .span+ .get_content(src)+ .eq_ignore_ascii_case_str("which")+ {+ return None;+ }++ let forspan = toks.last()?.span;+ Some(Lint {+ span: forspan,+ lint_kind: LintKind::Usage,+ suggestions: vec![Suggestion::replace_with_match_case_str(+ "of",+ forspan.get_content(src),+ )],+ message: "Did you mean `the point of`?".to_string(),+ ..Default::default()+ })+ }+}++#[cfg(test)]+mod tests {+ use super::ThePointFor;+ use crate::linting::tests::{assert_no_lints, assert_suggestion_result};++ #[test]+ fn fix_is() {+ assert_suggestion_result(+ "What is the point for this check?",+ ThePointFor::default(),+ "What is the point of this check?",+ );+ }++ #[test]+ #[ignore = "'that' is disabled to avoid false positives until the heuristics can be improved"]+ fn fix_thats_the_point_no_apostrophe() {+ assert_suggestion_result(+ "You should also keep an eye on the issue list because thats the point for being public",+ ThePointFor::default(),+ "You should also keep an eye on the issue list because thats the point of being public",+ );+ }++ #[test]+ fn fix_was_the_point() {+ assert_suggestion_result(+ "But avoiding to learn qraphql to find out the proper query was the point for asking for this convenience command.",+ ThePointFor::default(),+ "But avoiding to learn qraphql to find out the proper query was the point of asking for this convenience command.",+ );+ }++ #[test]+ fn fix_whats_the_point() {+ assert_suggestion_result(+ "What's the point for IRepository?",+ ThePointFor::default(),+ "What's the point of IRepository?",+ );+ }++ #[test]+ fn fix_whats_the_point_no_apostrophe() {+ // Whats the point for using a reader like feedly, if the articles open in their native website+ assert_suggestion_result(+ "## I dont get RSS. Whats the point for using a reader like feedly, if the articles open in their native website",+ ThePointFor::default(),+ "## I dont get RSS. Whats the point of using a reader like feedly, if the articles open in their native website",+ );+ }++ #[test]+ fn avoid_flagging_the_point_for_which() {+ assert_no_lints(+ "p0 is the point for which we want to find the closest point to the line",+ ThePointFor::default(),+ );+ }+}