Skip to content

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

feat: how do/does x compared/compares→compare (#3770)

Andrew Dunbar05d912daa0d3
diff --git a/harper-core/default_config.json b/harper-core/default_config.json
index babc6a4be..1f3038f5f 100644
--- a/harper-core/default_config.json
+++ b/harper-core/default_config.json
@@ -5411,6 +5411,13 @@
"label": "For The Nth Time"
}
},
+ {
+ "Bool": {
+ "name": "HowDoesCompared",
+ "state": true,
+ "label": "How Does Compared"
+ }
+ },
{
"Bool": {
"name": "AWaysToGo",
diff --git a/harper-core/src/linting/how_does_compared.rs b/harper-core/src/linting/how_does_compared.rs
new file mode 100644
index 000000000..3fbf7d6e8
--- /dev/null
+++ b/harper-core/src/linting/how_does_compared.rs
@@ -0,0 +1,125 @@
+use crate::{
+ Lint, Token,
+ expr::{Expr, SequenceExpr},
+ linting::{ExprLinter, LintKind, Suggestion, expr_linter::Chunk},
+};
+
+pub struct HowDoesCompared {
+ expr: SequenceExpr,
+}
+
+impl Default for HowDoesCompared {
+ fn default() -> Self {
+ Self {
+ expr: SequenceExpr::aco("how")
+ .t_ws()
+ .then_any_of([
+ Box::new(
+ SequenceExpr::aco("do")
+ .t_ws()
+ .t_set(&["these", "they", "those"]),
+ ) as Box<dyn Expr>,
+ Box::new(
+ SequenceExpr::aco("does")
+ .t_ws()
+ .t_set(&["it", "that", "this"]),
+ ),
+ Box::new(
+ SequenceExpr::aco("did")
+ .t_ws()
+ .t_set(&["it", "that", "these", "they", "this", "those"]),
+ ),
+ ])
+ .t_ws()
+ .t_set(&["compared", "compares"]),
+ }
+ }
+}
+
+impl ExprLinter for HowDoesCompared {
+ type Unit = Chunk;
+
+ fn match_to_lint(&self, toks: &[Token], src: &[char]) -> Option<Lint> {
+ let span = toks.last()?.span;
+
+ Some(Lint {
+ span,
+ lint_kind: LintKind::Grammar,
+ suggestions: vec![Suggestion::replace_with_match_case_str(
+ "compare",
+ span.get_content(src),
+ )],
+ message: "Use the base form of the verb `compare`.".to_owned(),
+ ..Default::default()
+ })
+ }
+
+ fn expr(&self) -> &dyn Expr {
+ &self.expr
+ }
+
+ fn description(&self) -> &str {
+ "Corrects `how do/does/did X compared/compares to Y` to use `compare`."
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::linting::tests::assert_suggestion_result;
+
+ use super::HowDoesCompared;
+
+ #[test]
+ fn fix_does_it_compared() {
+ assert_suggestion_result(
+ "Oo how does it compared to matrix chatGPT bot",
+ HowDoesCompared::default(),
+ "Oo how does it compare to matrix chatGPT bot",
+ );
+ }
+
+ #[test]
+ fn fix_does_it_compares() {
+ assert_suggestion_result(
+ "How does it compares to openspec or other spec driven frameworks?",
+ HowDoesCompared::default(),
+ "How does it compare to openspec or other spec driven frameworks?",
+ );
+ }
+
+ #[test]
+ fn fix_does_that_compared() {
+ assert_suggestion_result(
+ "Also I wonder if your touchscreen works with VoodooRMI, or how does that compared to VoodooI2CHID?",
+ HowDoesCompared::default(),
+ "Also I wonder if your touchscreen works with VoodooRMI, or how does that compare to VoodooI2CHID?",
+ );
+ }
+
+ #[test]
+ fn fix_does_that_compares() {
+ assert_suggestion_result(
+ "lets take a look at where we are as per the latest SBP payment system report and how does that compares with the historical trend for these figures",
+ HowDoesCompared::default(),
+ "lets take a look at where we are as per the latest SBP payment system report and how does that compare with the historical trend for these figures",
+ );
+ }
+
+ #[test]
+ fn fix_does_this_compared() {
+ assert_suggestion_result(
+ "How does this compared to other softwares like 3d-agent , threedle or SAM 3d from meta?",
+ HowDoesCompared::default(),
+ "How does this compare to other softwares like 3d-agent , threedle or SAM 3d from meta?",
+ );
+ }
+
+ #[test]
+ fn fix_does_this_compares() {
+ assert_suggestion_result(
+ "How does this compares to the RetinaFace?",
+ HowDoesCompared::default(),
+ "How does this compare to the RetinaFace?",
+ );
+ }
+}
diff --git a/harper-core/src/linting/lint_group/mod.rs b/harper-core/src/linting/lint_group/mod.rs
index e6f8eec43..c043624f0 100644
--- a/harper-core/src/linting/lint_group/mod.rs
+++ b/harper-core/src/linting/lint_group/mod.rs
@@ -118,6 +118,7 @@ use super::hello_greeting::HelloGreeting;
use super::helped_past::HelpedPast;
use super::hereby::Hereby;
use super::hop_hope::HopHope;
+use super::how_does_compared::HowDoesCompared;
use super::how_to::HowTo;
use super::hyphenate_number_day::HyphenateNumberDay;
use super::i_am_agreement::IAmAgreement;
@@ -691,6 +692,7 @@ impl LintGroup {
insert_expr_rule_with_dict!(HelpedPast);
insert_expr_rule!(Hereby);
insert_struct_rule!(HopHope);
+ insert_expr_rule!(HowDoesCompared);
insert_expr_rule!(HowTo);
insert_expr_rule!(HyphenateNumberDay);
insert_expr_rule!(IAmAgreement);
diff --git a/harper-core/src/linting/mod.rs b/harper-core/src/linting/mod.rs
index 1085cc7c8..461bcf529 100644
--- a/harper-core/src/linting/mod.rs
+++ b/harper-core/src/linting/mod.rs
@@ -115,6 +115,7 @@ mod helped_past;
mod hereby;
mod hop_hope;
mod hope_youre;
+mod how_does_compared;
mod how_to;
mod hyphenate_number_day;
mod i_am_agreement;