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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

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

pub struct ThePointFor {
    expr: SequenceExpr,
}

impl Default for ThePointFor {
    fn default() -> Self {
        Self {
            expr: SequenceExpr::any_of(vec![Box::new(WordSet::new(&[
                // "that's" leads to false positives: "that's the point for me"
                "is", "was", "what's", "whats",
            ]))])
            .t_ws()
            .t_aco("the")
            .t_ws()
            .t_aco("point")
            .t_ws()
            .t_aco("for"),
        }
    }
}

impl ExprLinter for ThePointFor {
    type Unit = Chunk;

    fn description(&self) -> &str {
        "Corrects `the point for` to `the point of`"
    }

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

    fn match_to_lint_with_context(
        &self,
        toks: &[Token],
        src: &[char],
        ctx: Option<(&[Token], &[Token])>,
    ) -> Option<Lint> {
        // Avoid flagging things like "p0 is the point for which we want to find the closest point to the line"
        if let Some((_, after)) = ctx
            && after.len() >= 2
            && after[0].kind.is_whitespace()
            && after[1].get_ch(src).eq_str("which")
        {
            return None;
        }

        let forspan = toks.last()?.span;
        Some(Lint {
            span: forspan,
            lint_kind: LintKind::Usage,
            suggestions: vec![Suggestion::replace_with_match_case_str(
                "of",
                forspan.get_content(src),
            )],
            message: "Did you mean `the point of`?".to_string(),
            ..Default::default()
        })
    }
}

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

    #[test]
    fn fix_is() {
        assert_suggestion_result(
            "What is the point for this check?",
            ThePointFor::default(),
            "What is the point of this check?",
        );
    }

    #[test]
    #[ignore = "'that' is disabled to avoid false positives until the heuristics can be improved"]
    fn fix_thats_the_point_no_apostrophe() {
        assert_suggestion_result(
            "You should also keep an eye on the issue list because thats the point for being public",
            ThePointFor::default(),
            "You should also keep an eye on the issue list because thats the point of being public",
        );
    }

    #[test]
    fn fix_was_the_point() {
        assert_suggestion_result(
            "But avoiding to learn qraphql to find out the proper query was the point for asking for this convenience command.",
            ThePointFor::default(),
            "But avoiding to learn qraphql to find out the proper query was the point of asking for this convenience command.",
        );
    }

    #[test]
    fn fix_whats_the_point() {
        assert_suggestion_result(
            "What's the point for IRepository?",
            ThePointFor::default(),
            "What's the point of IRepository?",
        );
    }

    #[test]
    fn fix_whats_the_point_no_apostrophe() {
        // Whats the point for using a reader like feedly, if the articles open in their native website
        assert_suggestion_result(
            "## I dont get RSS. Whats the point for using a reader like feedly, if the articles open in their native website",
            ThePointFor::default(),
            "## I dont get RSS. Whats the point of using a reader like feedly, if the articles open in their native website",
        );
    }

    #[test]
    fn avoid_flagging_the_point_for_which() {
        assert_no_lints(
            "p0 is the point for which we want to find the closest point to the line",
            ThePointFor::default(),
        );
    }
}