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

use super::{Lint, LintKind, Linter, Suggestion};
use crate::TokenStringExt;
use crate::{Document, TokenKind};

#[derive(Debug, Default)]
pub struct NoFrenchSpaces;

impl Linter for NoFrenchSpaces {
    fn lint(&mut self, document: &Document) -> Vec<Lint> {
        let mut output = Vec::new();

        for sentence in document.iter_sentences() {
            if let Some(space_idx) = sentence.iter_space_indices().next() {
                let space = &sentence[space_idx];

                if matches!(space.kind, TokenKind::Space(0)) {
                    continue;
                }
                if space_idx == 0 && space.span.len() != 1 {
                    output.push(Lint {
                        span: space.span,
                        lint_kind: LintKind::Formatting,
                        suggestions: vec![Suggestion::ReplaceWith(vec![' '])],
                        message: "French spaces are generally not recommended.".to_owned(),
                        priority: 15,
                    })
                }
            }
        }

        output
    }

    fn description(&self) -> &str {
        "Stops users from accidentally inserting French spaces."
    }
}

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

    use super::NoFrenchSpaces;

    #[test]
    fn fixes_basic() {
        assert_suggestion_result(
            "This is a short sentence.  This is another short sentence.",
            NoFrenchSpaces::default(),
            "This is a short sentence. This is another short sentence.",
        );
    }
}