Skip to content

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

feat: till date→to date (#3706)

Andrew Dunbar08f49969945b
diff --git a/harper-core/default_config.json b/harper-core/default_config.json
index 9aa25d36f..c65dd60fb 100644
--- a/harper-core/default_config.json
+++ b/harper-core/default_config.json
@@ -5348,6 +5348,13 @@
"label": "In Due Course"
}
},
+ {
+ "Bool": {
+ "name": "TillDate",
+ "state": true,
+ "label": "Till Date"
+ }
+ },
{
"Bool": {
"name": "AMeansToAnEnd",
diff --git a/harper-core/src/linting/lint_group/mod.rs b/harper-core/src/linting/lint_group/mod.rs
index d5f866094..6abec881a 100644
--- a/harper-core/src/linting/lint_group/mod.rs
+++ b/harper-core/src/linting/lint_group/mod.rs
@@ -261,6 +261,7 @@ use super::though_thought::ThoughThought;
use super::thrive_on::ThriveOn;
use super::throw_away::ThrowAway;
use super::throw_rubbish::ThrowRubbish;
+use super::till_date::TillDate;
use super::to_adverb::ToAdverb;
use super::to_two_too::ToTwoToo;
use super::touristic::Touristic;
@@ -579,6 +580,271 @@ impl LintGroup {
// Add all the more complex rules to the group.
// Please maintain alphabetical order.
// On *nix you can maintain sort order with `sort -t'(' -k2`
+ // <<<<<<< HEAD
+ // insert_expr_rule!(APart, true);
+ // insert_expr_rule!(ASomeTime, true);
+ // insert_expr_rule!(AWhile, true);
+ // insert_expr_rule!(Addicting, true);
+ // insert_expr_rule!(AdjectiveDoubleDegree, true);
+ // insert_struct_rule!(AdjectiveOfA, true);
+ // insert_expr_rule!(AfterLater, true);
+ // insert_expr_rule!(AllHellBreakLoose, true);
+ // insert_expr_rule!(AllIntentsAndPurposes, true);
+ // insert_expr_rule!(AllowTo, true);
+ // insert_expr_rule!(AmInTheMorning, true);
+ // insert_expr_rule!(AmountsFor, true);
+ // insert_struct_rule_with_dialect!(AnA, true);
+ // insert_expr_rule!(AndTheLike, true);
+ // insert_expr_rule!(AnotherThingComing, true);
+ // insert_expr_rule!(AnotherThinkComing, false);
+ // insert_expr_rule!(ApartFrom, true);
+ // insert_expr_rule!(ArriveTo, true);
+ // insert_expr_rule!(AsHow, true);
+ // insert_expr_rule!(AsToInterrogative, true);
+ // insert_expr_rule!(AskNoPreposition, true);
+ // insert_expr_rule!(AvoidContractions, false);
+ // insert_expr_rule!(AvoidCurses, true);
+ // insert_expr_rule!(BackInTheDay, true);
+ // insert_expr_rule!(BeAllowed, true);
+ // insert_expr_rule!(BehindTheScenes, true);
+ // insert_struct_rule!(BestOfAllTime, true);
+ // insert_expr_rule!(BoringWords, false);
+ // insert_expr_rule!(Bought, true);
+ // insert_expr_rule!(BrandBrandish, true);
+ // insert_expr_rule!(ByAccident, true);
+ // insert_expr_rule!(ByTheBook, true);
+ // insert_expr_rule!(CallThem, true);
+ // insert_expr_rule!(Cant, true);
+ // insert_struct_rule!(CapitalizePersonalPronouns, true);
+ // insert_expr_rule!(Catch22, true);
+ // insert_expr_rule!(CautionaryTale, true);
+ // insert_expr_rule!(ChangeTack, true);
+ // insert_expr_rule!(ChockFull, true);
+ // insert_expr_rule!(CloseTightKnit, true);
+ // insert_expr_rule!(CodeInWriteIn, true);
+ // insert_struct_rule!(CommaFixes, true);
+ // insert_expr_rule!(ComplainAsNoun, true);
+ // insert_struct_rule!(CompoundNouns, true);
+ // insert_expr_rule!(CompoundSubjectI, true);
+ // insert_expr_rule!(Confident, true);
+ // insert_struct_rule!(CorrectNumberSuffix, true);
+ // insert_expr_rule!(CraveFor, true);
+ // insert_expr_rule!(CriteriaPhenomena, true);
+ // insert_expr_rule!(CureFor, true);
+ // insert_struct_rule!(CurrencyPlacement, true);
+ // insert_expr_rule!(Dashes, true);
+ // insert_expr_rule!(DayAndAge, true);
+ // insert_expr_rule!(DespiteItIs, true);
+ // insert_expr_rule!(DespiteOf, true);
+ // insert_expr_rule_with_dict!(DidPast, true);
+ // insert_expr_rule!(Didnt, true);
+ // insert_struct_rule!(DiscourseMarkers, true);
+ // insert_expr_rule_with_dict!(DisjointPrefixes, true);
+ // insert_expr_rule!(DoMistake, true);
+ // insert_expr_rule!(DotInitialisms, true);
+ // insert_expr_rule!(DoubleClick, true);
+ // insert_expr_rule!(DoubleModal, true);
+ // insert_struct_rule!(EllipsisLength, true);
+ // insert_expr_rule!(ElsePossessive, true);
+ // insert_expr_rule!(EverEvery, true);
+ // insert_expr_rule!(Everyday, true);
+ // insert_expr_rule!(ExceptOf, true);
+ // insert_expr_rule!(ExpandMemoryShorthands, true);
+ // insert_expr_rule!(ExpandPeople, true);
+ // insert_expr_rule!(ExpandTimeShorthands, true);
+ // insert_expr_rule!(FarBeIt, true);
+ // insert_expr_rule!(FascinatedBy, true);
+ // insert_expr_rule_with_dialect!(FedUpWith, true);
+ // insert_expr_rule!(FeelFell, true);
+ // insert_expr_rule!(FellowCoRedundancy, true);
+ // insert_expr_rule!(FewUnitsOfTimeAgo, true);
+ // insert_expr_rule!(FillerWords, true);
+ // insert_struct_rule!(FindFine, true);
+ // insert_expr_rule!(FirstAidKit, true);
+ // insert_expr_rule!(FleshOutVsFullFledged, true);
+ // insert_expr_rule!(FootInchMinuteSecondSymbols, true);
+ // insert_expr_rule!(ForFreeOfCharge, true);
+ // insert_expr_rule!(ForNoun, true);
+ // insert_expr_rule!(FreePredicate, true);
+ // insert_expr_rule!(FriendOfMe, true);
+ // insert_expr_rule!(GoSoFarAsTo, true);
+ // insert_expr_rule!(GoToWar, true);
+ // insert_expr_rule!(GoodAt, true);
+ // insert_expr_rule!(Handful, true);
+ // insert_expr_rule!(HandfulOfMore, true);
+ // insert_expr_rule!(HavePronoun, true);
+ // insert_struct_rule_with_dialect!(HaveTakeALook, true);
+ // insert_expr_rule!(Hedging, true);
+ // insert_expr_rule!(HelloGreeting, true);
+ // insert_expr_rule!(Hereby, true);
+ // insert_struct_rule!(HopHope, true);
+ // insert_expr_rule!(HowTo, true);
+ // insert_expr_rule!(HyphenateNumberDay, true);
+ // insert_expr_rule!(IAmAgreement, true);
+ // insert_expr_rule!(IfWouldve, true);
+ // insert_expr_rule!(InDemandInDepth, true);
+ // insert_expr_rule!(InFavourOfDoing, true);
+ // insert_struct_rule_with_dialect!(InOnTheCards, true);
+ // insert_expr_rule!(InTimeFromNow, true);
+ // insert_struct_rule_with_dict!(InflectedVerbAfterTo, true);
+ // insert_expr_rule!(InterestedIn, true);
+ // insert_expr_rule!(ItLooksLikeThat, true);
+ // insert_struct_rule!(ItsContraction, true);
+ // insert_expr_rule!(ItsPossessive, true);
+ // insert_expr_rule!(JealousOf, true);
+ // insert_expr_rule!(JohnsHopkins, true);
+ // insert_expr_rule!(LeadRiseTo, true);
+ // insert_expr_rule!(LeavingInDroves, true);
+ // insert_expr_rule!(LeftRightHand, true);
+ // insert_expr_rule!(LessWorse, true);
+ // insert_expr_rule!(LetToDo, true);
+ // insert_struct_rule!(LetsConfusion, true);
+ // insert_expr_rule!(Likewise, true);
+ // insert_struct_rule!(LongSentences, true);
+ // insert_expr_rule!(LongTimeAgo, true);
+ // insert_expr_rule!(LookDownOnesNose, true);
+ // insert_expr_rule!(LookingForwardTo, true);
+ // insert_struct_rule_with_dict!(MassNouns, true);
+ // insert_expr_rule!(MeansALotTo, true);
+ // insert_struct_rule!(MergeWords, true);
+ // insert_expr_rule!(MissingPreposition, true);
+ // insert_expr_rule!(MissingTo, true);
+ // insert_expr_rule!(Misspell, true);
+ // insert_expr_rule!(MixedBag, true);
+ // insert_expr_rule!(ModalBeAdjective, true);
+ // insert_expr_rule!(ModalOf, true);
+ // insert_expr_rule!(ModalSeem, true);
+ // insert_expr_rule!(Months, true);
+ // insert_expr_rule_with_dict!(MoreAdjective, true);
+ // insert_expr_rule!(MoreBetter, true);
+ // insert_expr_rule!(MostNumber, true);
+ // insert_expr_rule!(MostOfTheTimes, true);
+ // insert_expr_rule!(MultipleSequentialPronouns, true);
+ // insert_expr_rule!(NailOnTheHead, true);
+ // insert_expr_rule!(NakedEye, true);
+ // insert_expr_rule!(NeedToNoun, true);
+ // insert_struct_rule!(NoFrenchSpaces, true);
+ // insert_expr_rule!(NoLonger, true);
+ // insert_expr_rule!(NoMatchFor, true);
+ // insert_struct_rule!(NoOxfordComma, false);
+ // insert_expr_rule!(Nobody, true);
+ // insert_expr_rule!(NominalWants, true);
+ // insert_expr_rule!(NorModalPronoun, true);
+ // insert_expr_rule!(NotOnlyInversion, true);
+ // insert_struct_rule!(NounVerbConfusion, true);
+ // insert_struct_rule!(NumberSuffixCapitalization, true);
+ // insert_expr_rule!(NumericRangeEnDash, true);
+ // insert_expr_rule!(ObsessPreposition, true);
+ // insert_expr_rule!(OfCourse, true);
+ // insert_expr_rule!(OldestInTheBook, true);
+ // insert_expr_rule!(OnFloor, true);
+ // insert_expr_rule!(OnceOrTwice, true);
+ // insert_expr_rule!(OneAndTheSame, true);
+ // insert_expr_rule_with_dict!(OneOfTheSingular, true);
+ // insert_expr_rule!(OpenCompounds, true);
+ // insert_expr_rule!(OpenTheLight, true);
+ // insert_expr_rule!(OrthographicConsistency, true);
+ // insert_expr_rule!(OughtToBe, true);
+ // insert_expr_rule!(OutOfDate, true);
+ // insert_expr_rule_with_dialect!(OutOfTheWindow, true);
+ // insert_struct_rule!(OxfordComma, true);
+ // insert_expr_rule!(Oxymorons, true);
+ // insert_expr_rule!(PayForPrice, true);
+ // insert_struct_rule!(PhrasalVerbAsCompoundNoun, true);
+ // insert_expr_rule!(PiqueInterest, true);
+ // insert_expr_rule!(PluralWrongWordOfPhrase, true);
+ // insert_struct_rule_with_dict!(PossessiveNoun, false);
+ // insert_expr_rule!(PossessiveYour, true);
+ // insert_expr_rule!(ProgressiveNeedsBe, true);
+ // insert_expr_rule!(PronounAre, true);
+ // insert_struct_rule!(PronounContraction, true);
+ // insert_expr_rule!(PronounInflectionBe, true);
+ // insert_expr_rule!(PronounKnew, true);
+ // insert_expr_rule_with_dict!(PronounVerbAgreement, true);
+ // insert_expr_rule!(QuantifierNeedsOf, true);
+ // insert_expr_rule!(QuantifierNumeralConflict, true);
+ // insert_expr_rule!(QuiteQuiet, true);
+ // insert_struct_rule!(QuoteSpacing, true);
+ // insert_expr_rule!(ReasonForDoing, true);
+ // insert_expr_rule!(RedundantAcronyms, true);
+ // insert_expr_rule!(RedundantAdditiveAdverbs, true);
+ // insert_expr_rule!(RedundantProgressiveComparative, true);
+ // insert_struct_rule_with_dialect!(Regionalisms, true);
+ // insert_expr_rule_with_dict!(RegularIrregulars, true);
+ // insert_struct_rule!(RepeatedWords, true);
+ // insert_expr_rule!(Respond, true);
+ // insert_expr_rule!(RightClick, true);
+ // insert_expr_rule!(RiseTheRanks, true);
+ // insert_expr_rule!(RollerSkated, true);
+ // insert_expr_rule!(RunIntoProblemsOrTrouble, true);
+ // insert_expr_rule!(SafeToSave, true);
+ // insert_expr_rule!(SaveToSafe, true);
+ // insert_struct_rule_with_dict!(SentenceCapitalization, true);
+ // insert_expr_rule!(ShootOneselfInTheFoot, true);
+ // insert_expr_rule!(SimplePastToPastParticiple, true);
+ // insert_expr_rule!(SinceDuration, true);
+ // insert_expr_rule!(SingleBe, true);
+ // insert_struct_rule!(SneakedSnuck, true);
+ // insert_expr_rule!(SomeWithoutArticle, true);
+ // insert_expr_rule!(SomethingIs, true);
+ // insert_expr_rule!(SomewhatSomething, true);
+ // insert_expr_rule!(SoonToBe, true);
+ // insert_expr_rule!(SoughtAfter, true);
+ // insert_struct_rule!(Spaces, true);
+ // insert_struct_rule!(SpelledNumbers, false);
+ // insert_expr_rule!(SplitWords, true);
+ // insert_struct_rule!(SubjectPronoun, true);
+ // insert_expr_rule!(TakeALookTo, true);
+ // insert_expr_rule!(TakeMedicine, true);
+ // insert_expr_rule!(ThatThan, true);
+ // insert_expr_rule!(ThatWhich, true);
+ // insert_expr_rule!(TheHowWhy, true);
+ // insert_expr_rule!(TheLastDays, true);
+ // insert_expr_rule!(TheMy, true);
+ // insert_expr_rule!(ThePointFor, true);
+ // insert_expr_rule!(TheProperNounPossessive, true);
+ // insert_expr_rule!(TheTheToThatThe, true);
+ // insert_expr_rule!(ThenThan, true);
+ // insert_expr_rule!(ThereOwn, true);
+ // insert_expr_rule!(Theres, true);
+ // insert_expr_rule!(ThesesThese, true);
+ // insert_struct_rule!(TheyreConfusions, true);
+ // insert_expr_rule!(ThingThink, true);
+ // insert_expr_rule!(ThisTypeOfThing, true);
+ // insert_expr_rule!(ThoughThought, true);
+ // insert_expr_rule!(ThriveOn, true);
+ // insert_expr_rule!(ThrowAway, true);
+ // insert_struct_rule!(ThrowRubbish, true);
+ // insert_expr_rule_with_dialect!(TillDate, true);
+ // insert_expr_rule!(ToAdverb, true);
+ // insert_struct_rule!(ToTwoToo, true);
+ // insert_expr_rule!(Touristic, true);
+ // insert_expr_rule_with_dict!(TransposedSpace, true);
+ // insert_expr_rule!(TryOnesHandAt, true);
+ // insert_expr_rule!(TryOnesLuck, true);
+ // insert_struct_rule!(UnclosedQuotes, true);
+ // insert_expr_rule!(UpdatePlaceNames, true);
+ // insert_struct_rule!(UseEllipsisCharacter, true);
+ // insert_struct_rule_with_dict!(UseTitleCase, true);
+ // insert_expr_rule!(VerbToAdjective, true);
+ // insert_expr_rule!(VeryUnique, true);
+ // insert_expr_rule!(ViceVersa, true);
+ // insert_expr_rule!(ViciousCircle, true);
+ // insert_expr_rule!(ViciousCircleOrCycle, false);
+ // insert_expr_rule!(ViciousCycle, false);
+ // insert_expr_rule!(WasAloud, true);
+ // insert_expr_rule!(WayTooAdjective, true);
+ // insert_expr_rule!(WellEducated, true);
+ // insert_expr_rule!(Whereas, true);
+ // insert_expr_rule!(WhomSubjectOfVerb, true);
+ // insert_expr_rule!(WidelyAccepted, true);
+ // insert_expr_rule_with_dict!(WillNonLemma, true);
+ // insert_expr_rule!(WinPrize, true);
+ // insert_expr_rule!(WishCould, true);
+ // insert_struct_rule!(WordPressDotcom, true);
+ // insert_expr_rule_with_dict!(WorthToDo, true);
+ // insert_expr_rule!(WouldNeverHave, true);
+ // =======
insert_expr_rule!(APart);
insert_expr_rule!(ASomeTime);
insert_expr_rule!(AWhile);
@@ -822,6 +1088,7 @@ impl LintGroup {
insert_expr_rule!(ThriveOn);
insert_expr_rule!(ThrowAway);
insert_struct_rule!(ThrowRubbish);
+ insert_expr_rule_with_dialect!(TillDate);
insert_expr_rule!(ToAdverb);
insert_struct_rule!(ToTwoToo);
insert_expr_rule!(Touristic);
@@ -850,6 +1117,7 @@ impl LintGroup {
insert_struct_rule!(WordPressDotcom);
insert_expr_rule_with_dict!(WorthToDo);
insert_expr_rule!(WouldNeverHave);
+ // >>>>>>> 515a97b7f93b4afbcfe138e80e79140a3faab133
// Uses Sentence rather than Chunk
out.add("AspireTo", AspireTo::default());
diff --git a/harper-core/src/linting/mod.rs b/harper-core/src/linting/mod.rs
index 27312f26d..b82479b15 100644
--- a/harper-core/src/linting/mod.rs
+++ b/harper-core/src/linting/mod.rs
@@ -273,6 +273,7 @@ mod though_thought;
mod thrive_on;
mod throw_away;
mod throw_rubbish;
+mod till_date;
mod to_adverb;
mod to_two_too;
mod touristic;
diff --git a/harper-core/src/linting/till_date.rs b/harper-core/src/linting/till_date.rs
new file mode 100644
index 000000000..0d878abf3
--- /dev/null
+++ b/harper-core/src/linting/till_date.rs
@@ -0,0 +1,148 @@
+use crate::{
+ CharStringExt, Dialect, Lint, Token,
+ expr::{Expr, SequenceExpr},
+ linting::{ExprLinter, LintKind, Suggestion, expr_linter::Chunk},
+};
+
+pub struct TillDate {
+ expr: SequenceExpr,
+ dialect: Dialect,
+}
+
+impl TillDate {
+ pub fn new(dialect: Dialect) -> Self {
+ Self {
+ expr: SequenceExpr::word_set(&["till", "til", "'til", "til'"])
+ .t_ws()
+ .t_aco("date"),
+ dialect,
+ }
+ }
+}
+
+impl ExprLinter for TillDate {
+ type Unit = Chunk;
+
+ fn match_to_lint_with_context(
+ &self,
+ toks: &[Token],
+ src: &[char],
+ ctx: Option<(&[Token], &[Token])>,
+ ) -> Option<Lint> {
+ // TODO: It might be better to also have a preference to flag this even in Indian English?
+ if self.dialect == Dialect::Indian {
+ return None;
+ }
+
+ const GOOD_TOKENS: &[&str] = &["good", "valid"];
+
+ // "Good Till Date" (GTD) is a term of art in finance.
+ // Don't flag:
+ // [good] [ws] <till date pattern>
+ // [good] [ws] [apostrophe] <till date pattern>
+ if let Some((before, _)) = ctx
+ && let [before @ .., prevprev, prev] = before
+ {
+ if prev.kind.is_whitespace()
+ && prevprev
+ .get_ch(src)
+ .eq_any_ignore_ascii_case_str(GOOD_TOKENS)
+ {
+ return None;
+ }
+
+ if prev.kind.is_apostrophe()
+ && prevprev.kind.is_whitespace()
+ && let [.., prevprevprev] = before
+ && prevprevprev
+ .get_ch(src)
+ .eq_any_ignore_ascii_case_str(GOOD_TOKENS)
+ {
+ return None;
+ }
+ }
+
+ let till_idx = 0;
+ let till_tok = &toks[till_idx];
+ let till_span = till_tok.span;
+
+ Some(Lint {
+ span: till_span,
+ lint_kind: LintKind::Regionalism,
+ suggestions: vec![Suggestion::replace_with_match_case_str(
+ "to",
+ till_span.get_content(src),
+ )],
+ message: "Outside Indian English, prefer `to date`.".to_owned(),
+ ..Default::default()
+ })
+ }
+
+ fn expr(&self) -> &dyn Expr {
+ &self.expr
+ }
+
+ fn description(&self) -> &str {
+ "Corrects the Indian English `till date` to `to date` when Indian English is not the selected dialect."
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::{
+ Dialect,
+ linting::tests::{assert_no_lints, assert_suggestion_result},
+ };
+
+ use super::TillDate;
+
+ #[test]
+ fn fix_till_date_double_l() {
+ assert_suggestion_result(
+ "This repository contains all my REXX codes till date.",
+ TillDate::new(Dialect::American),
+ "This repository contains all my REXX codes to date.",
+ );
+ }
+
+ #[test]
+ fn fix_till_date_single_l() {
+ assert_suggestion_result(
+ "streams recorded on the platform from 1930 til date",
+ TillDate::new(Dialect::American),
+ "streams recorded on the platform from 1930 to date",
+ );
+ }
+
+ #[test]
+ fn dont_flag_til_date_apostrophe_before_single_l() {
+ assert_no_lints(
+ "A good 'til date (GTD) order is an instruction to buy or sell an asset that remains open until a future date specified by the trader.",
+ TillDate::new(Dialect::American),
+ );
+ }
+
+ #[test]
+ fn dont_flag_good_til_date_apostrophe_after_single_l() {
+ assert_no_lints(
+ "Can someone give me some information as to what the Good Til' date means in the context of buying shares?",
+ TillDate::new(Dialect::American),
+ );
+ }
+
+ #[test]
+ fn dont_flag_good_till_date_double_l_all_caps() {
+ assert_no_lints(
+ "TERMS AND CONDITIONS FOR GOOD TILL DATE (GTD) ORDERS.",
+ TillDate::new(Dialect::American),
+ );
+ }
+
+ #[test]
+ fn dont_flag_valid_till_date() {
+ assert_no_lints(
+ "The quotation states: \"Good till date (GTD) orders are valid until a specified date.\"",
+ TillDate::new(Dialect::American),
+ );
+ }
+}