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

use crate::expr::Expr;

use crate::{Token, patterns::Word};

use super::{ExprLinter, Lint, LintKind, Suggestion};
use crate::linting::expr_linter::Chunk;

/// Alias for a word in an initialism expansion
type InitialismWord = Vec<char>;
/// Alias for a phrase an initialism expands to
type InitialismPhrase = Vec<InitialismWord>;

/// A struct that can be composed to expand initialisms, respecting the capitalization of each
/// item.
pub struct InitialismLinter {
    expr: Word,
    /// The lowercase-normalized expansion of the initialism.
    expansions_lower: Vec<InitialismPhrase>,
}

impl InitialismLinter {
    /// Construct a linter that can correct an initialism to
    pub fn new(initialism: &str, expansions: &[&str]) -> Self {
        let expansions_lower = expansions
            .iter()
            .map(|expansion| {
                expansion
                    .split(' ')
                    .map(|s| s.chars().map(|v| v.to_ascii_lowercase()).collect())
                    .collect()
            })
            .collect();

        Self {
            expr: Word::from_char_string(initialism.chars().collect()),
            expansions_lower,
        }
    }
}

impl ExprLinter for InitialismLinter {
    type Unit = Chunk;

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

    fn match_to_lint(&self, matched_tokens: &[Token], source: &[char]) -> Option<Lint> {
        let tok = matched_tokens.first()?;
        let source = tok.get_ch(source);

        let suggestions = self
            .expansions_lower
            .iter()
            .map(|expansion_lower| {
                let mut expansion = expansion_lower.clone();
                let first_letter = &mut expansion[0][0];
                *first_letter = if source[0].is_ascii_uppercase() {
                    first_letter.to_ascii_uppercase()
                } else {
                    first_letter.to_ascii_lowercase()
                };
                Suggestion::ReplaceWith(
                    expansion
                        .iter()
                        .flat_map(|word| std::iter::once(' ').chain(word.iter().copied()))
                        .skip(1)
                        .collect::<Vec<_>>(),
                )
            })
            .collect::<Vec<_>>();

        Some(Lint {
            span: tok.span,
            lint_kind: LintKind::Miscellaneous,
            suggestions,
            message: "Try expanding this initialism.".to_owned(),
            priority: 127,
        })
    }

    fn description(&self) -> &'static str {
        "Expands an initialism."
    }
}

#[cfg(test)]
mod tests {}