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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use crate::linting::expr_linter::Chunk;
use crate::{
    Token, TokenStringExt,
    expr::{Expr, SequenceExpr},
    linting::{ExprLinter, Lint, LintKind, Suggestion},
};

pub struct Misspell {
    expr: SequenceExpr,
}

impl Default for Misspell {
    fn default() -> Self {
        let expr = SequenceExpr::word_set(&["miss"]).t_ws_h().then_word_set(&[
            "spell",
            "spelled",
            "spelling",
            "spells",
            "spellings",
        ]);

        Self { expr }
    }
}

impl ExprLinter for Misspell {
    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.span()?;
        let misspell_variant = matched_tokens.last()?;

        let variant_chars = misspell_variant.get_ch(source);
        let variant_lower = variant_chars
            .iter()
            .map(|c| c.to_ascii_lowercase())
            .collect::<String>();

        let replacement = match variant_lower.as_str() {
            "spell" => "misspell",
            "spelled" => "misspelled",
            "spelling" => "misspelling",
            "spells" => "misspells",
            "spellings" => "misspellings",
            _ => return None,
        };

        let suggestions = vec![Suggestion::replace_with_match_case(
            replacement.chars().collect(),
            span.get_content(source),
        )];

        Some(Lint {
            span,
            lint_kind: LintKind::BoundaryError,
            suggestions,
            message: "Write `misspell` and its inflections as a single word.".to_string(),
            priority: 63,
        })
    }

    fn description(&self) -> &'static str {
        "Ensures `misspell` and its inflected forms are written as a single word."
    }
}

#[cfg(test)]
mod tests {
    use crate::linting::tests::assert_suggestion_result;

    use super::Misspell;

    #[test]
    fn base_form() {
        assert_suggestion_result(
            "They often miss spell names in the log.",
            Misspell::default(),
            "They often misspell names in the log.",
        );
    }

    #[test]
    fn past_tense() {
        assert_suggestion_result(
            "She miss spelled the answer on the quiz.",
            Misspell::default(),
            "She misspelled the answer on the quiz.",
        );
    }

    #[test]
    fn past_tense_hyphen() {
        assert_suggestion_result(
            "She miss-spelled the answer on the quiz.",
            Misspell::default(),
            "She misspelled the answer on the quiz.",
        );
    }

    #[test]
    fn gerund_form() {
        assert_suggestion_result(
            "His constant miss spelling frustrated the team.",
            Misspell::default(),
            "His constant misspelling frustrated the team.",
        );
    }
}