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

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

pub struct BehindTheScenes {
    expr: SequenceExpr,
}

impl Default for BehindTheScenes {
    fn default() -> Self {
        Self {
            expr: SequenceExpr::aco("behind")
                .t_ws_h()
                .t_aco("the")
                .t_ws_h()
                .t_aco("scene"),
        }
    }
}

impl ExprLinter for BehindTheScenes {
    type Unit = Chunk;

    fn description(&self) -> &str {
        "Corrects `behind the scene` to `behind the scenes`."
    }

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

    fn match_to_lint_with_context(
        &self,
        toks: &[Token],
        src: &[char],
        ctx: Option<(&[Token], &[Token])>,
    ) -> Option<Lint> {
        if let Some((before, _)) = ctx
            && before.last().is_some_and(|t| t.kind.is_hyphen())
        {
            return None;
        }

        let span = toks.last()?.span;
        Some(Lint {
            span,
            lint_kind: LintKind::Usage,
            suggestions: [Suggestion::replace_with_match_case_str(
                "scenes",
                span.get_content(src),
            )]
            .to_vec(),
            message: "This idiom uses the plural `scenes`.".to_string(),
            ..Default::default()
        })
    }
}

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

    #[test]
    fn pluralize_work_bts() {
        assert_suggestion_result(
            "How does this tool work behind the scene.",
            BehindTheScenes::default(),
            "How does this tool work behind the scenes.",
        );
    }

    #[test]
    #[ignore = "Correcting hyphenation is not yet implemented."]
    fn pluralize_and_hyphenate() {
        assert_suggestion_result(
            "So, to open the 'real' behind the scene menu i need to do these steps:",
            BehindTheScenes::default(),
            "So, to open the 'real' behind-the-scenes menu i need to do these steps:",
        );
    }

    #[test]
    fn dont_flag_when_hyphenated_to_previous_word() {
        assert_no_lints(
            "Contribute to techking11/react-behind-the-scene development by creating an account on GitHub.",
            BehindTheScenes::default(),
        );
    }

    #[test]
    fn pluralize_bts_processing() {
        assert_suggestion_result(
            "Behind-the-scene processing details are printed in the Log window.",
            BehindTheScenes::default(),
            "Behind-the-scenes processing details are printed in the Log window.",
        );
    }
}