Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(core): make narrow linter specifically for long and behold #641

Merged
merged 1 commit into from
Feb 10, 2025
Merged

fix(core): make narrow linter specifically for long and behold #641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 31 additions & 18 deletions harper-core/src/linting/phrase_corrections.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,9 @@
use super::{Lint, LintKind, PatternLinter};
use crate::linting::Suggestion;
use crate::patterns::{Pattern, SimilarToPhrase};
use crate::patterns::{ExactPhrase, Pattern, SimilarToPhrase};
use crate::{Token, TokenStringExt};

/// Generate a linter that will look for a common phrase and correct mild errors that
/// are still composed of real words.
macro_rules! create_linter_for_phrase {
($name:ident, $correct_form:literal, $dist:literal) => {
create_linter_for_phrase!(
$name,
SimilarToPhrase::from_phrase($correct_form, $dist),
$correct_form,
concat!("Did you mean the phrase `", $correct_form, "`?"),
concat!(
"Looks for slight improper modifications to the phrase `",
$correct_form,
"`."
)
);
};
macro_rules! create_linter_map_phrase {
($name:ident, $pattern:expr, $correct_form:expr, $message:expr, $description:expr) => {
#[doc = $description]
pub struct $name {
Expand Down Expand Up @@ -67,6 +52,24 @@ macro_rules! create_linter_for_phrase {
};
}

/// Generate a linter that will look for a common phrase and correct mild errors that
/// are still composed of real words.
macro_rules! create_linter_for_phrase {
($name:ident, $correct_form:literal, $dist:literal) => {
create_linter_map_phrase!(
$name,
SimilarToPhrase::from_phrase($correct_form, $dist),
$correct_form,
concat!("Did you mean the phrase `", $correct_form, "`?"),
concat!(
"Looks for slight improper modifications to the phrase `",
$correct_form,
"`."
)
);
};
}

create_linter_for_phrase!(TurnItOff, "turn it off", 1);
create_linter_for_phrase!(HumanLife, "human life", 1);
create_linter_for_phrase!(ThatChallenged, "that challenged", 2);
Expand All @@ -81,12 +84,13 @@ create_linter_for_phrase!(ChangeTack, "change tack", 1);
create_linter_for_phrase!(HungerPang, "hunger pang", 2);
create_linter_for_phrase!(EnMasse, "en masse", 1);
create_linter_for_phrase!(LetAlone, "let alone", 1);
create_linter_for_phrase!(LoAndBehold, "lo and behold", 2);
create_linter_for_phrase!(SneakingSuspicion, "sneaking suspicion", 3);
create_linter_for_phrase!(SpecialAttention, "special attention", 1);
create_linter_for_phrase!(ThanOthers, "than others", 1);
create_linter_for_phrase!(SupposedTo, "supposed to", 1);

create_linter_map_phrase!(LoAndBehold, ExactPhrase::from_phrase("long and behold"), "lo and behold", "Did you mean `lo and behold`?", "Detects the exact phrase `long and behold` and suggests replacing it with the idiomatically correct `lo and behold`");

#[cfg(test)]
mod tests {
use crate::linting::tests::{assert_lint_count, assert_suggestion_result};
Expand Down Expand Up @@ -201,4 +205,13 @@ mod tests {
fn than_others() {
assert_suggestion_result("Then others", ThanOthers::default(), "Than others");
}

#[test]
fn now_on_hold() {
assert_lint_count(
"Those are now on hold for month.",
LoAndBehold::default(),
0,
);
}
}