harper-core 2.0.0

The language checker for developers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

use crate::expr::Expr;
use crate::expr::OwnedExprExt;
use crate::expr::SequenceExpr;
use crate::{
    Token,
    patterns::{NominalPhrase, Word},
};

use super::{ExprLinter, Lint, LintKind, Suggestion};
use crate::linting::expr_linter::Chunk;

pub struct ForNoun {
    expr: SequenceExpr,
}

impl Default for ForNoun {
    fn default() -> Self {
        let pattern = SequenceExpr::aco("fro")
            .then_whitespace()
            .then(NominalPhrase.or(Word::new("sure")));

        Self { expr: pattern }
    }
}

impl ExprLinter for ForNoun {
    type Unit = Chunk;

    fn expr(&self) -> &dyn Expr {
        &self.expr
    }

    fn match_to_lint(&self, matched_tokens: &[Token], source: &[char]) -> Option<Lint> {
        let span = matched_tokens.first()?.span;
        let problem_chars = span.get_content(source);

        Some(Lint {
            span,
            lint_kind: LintKind::WordChoice,
            suggestions: vec![Suggestion::replace_with_match_case_str(
                "for",
                problem_chars,
            )],
            message: "`For` is more common in this context.".to_owned(),
            priority: 31,
        })
    }

    fn description(&self) -> &'static str {
        "Corrects the archaic or mistaken `fro` to `for` when followed by a noun."
    }
}

#[cfg(test)]
mod tests {
    use super::ForNoun;
    use crate::linting::tests::{assert_lint_count, assert_suggestion_result};

    #[test]
    fn corrects_fro_basic_correction() {
        assert_suggestion_result(
            "I got a text fro Sarah.",
            ForNoun::default(),
            "I got a text for Sarah.",
        );
    }

    #[test]
    fn allows_for_clean() {
        assert_lint_count("I got a text for Sarah.", ForNoun::default(), 0);
    }

    #[test]
    fn corrects_fro_sure() {
        assert_suggestion_result(
            "He was away fro sure!",
            ForNoun::default(),
            "He was away for sure!",
        );
    }
}