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

use crate::{CharString, CharStringExt, TokenStringExt};

use super::{Lint, LintKind, Linter, Suggestion};

/// Make sure you properly capitalize `WordPress.com`.
#[derive(Default)]
pub struct WordPressDotcom;

impl Linter for WordPressDotcom {
    fn lint(&mut self, document: &crate::Document) -> Vec<Lint> {
        let correct: CharString = "WordPress.com".chars().collect();
        let correct_lower = correct.to_lower();
        let mut lints = Vec::new();

        for hostname in document.iter_hostnames() {
            let text = document.get_span_content(&hostname.span);

            if correct.as_slice() != text && text.to_lower() == correct_lower {
                lints.push(Lint {
                    span: hostname.span,
                    lint_kind: LintKind::Style,
                    suggestions: vec![Suggestion::ReplaceWith(correct.to_vec())],
                    message: "The WordPress hosting provider should be stylized as `WordPress.com`"
                        .to_owned(),
                    priority: 31,
                });
            }
        }

        lints
    }

    fn description(&self) -> &str {
        "Ensures correct capitalization of WordPress.com. This rule verifies that the official stylization of WordPress.com is used when referring to the hosting provider."
    }
}

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

    use super::WordPressDotcom;

    #[test]
    fn simple() {
        assert_suggestion_result("wordpress.com", WordPressDotcom, "WordPress.com");
    }

    #[test]
    fn sentence() {
        assert_suggestion_result(
            "wordpress.com is a great hosting provider",
            WordPressDotcom,
            "WordPress.com is a great hosting provider",
        );
    }
}