prosesmasher-app-core 0.1.7

Internal core checks crate for the prosesmasher workspace. Published to support the workspace dependency graph.
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

//! Simplicity check — flags complex words that have simpler alternatives.

use std::collections::BTreeSet;

use low_expectations::ExpectationSuite;
use prosesmasher_domain_types::{CheckConfig, Document, Locale};

use crate::check::Check;

/// Checks that none of the configured complex words appear in the document.
///
/// Uses the `simplicity_pairs` config to build a set of complex words.
/// Words are matched case-insensitively. Matches in code blocks and list
/// items are ignored.
#[derive(Debug)]
pub struct SimplicityCheck;

impl Check for SimplicityCheck {
    fn id(&self) -> &'static str {
        "simplicity"
    }

    fn label(&self) -> &'static str {
        "Simplicity"
    }

    fn supported_locales(&self) -> Option<&'static [Locale]> {
        None
    }

    fn run(&self, doc: &Document, config: &CheckConfig, suite: &mut ExpectationSuite) {
        let simplicity_pairs = super::resolve_simplicity_pairs(config);
        if simplicity_pairs.is_empty() {
            return;
        }

        let complex_set: BTreeSet<String> = simplicity_pairs
            .iter()
            .map(|pair| pair.complex.to_lowercase())
            .collect();

        let all_words: Vec<&str> = doc
            .sections
            .iter()
            .flat_map(|s| &s.blocks)
            .flat_map(|b| super::collect_paragraph_words(b))
            .collect();

        let _result = suite
            .expect_terms_absent("simplicity", &all_words, &complex_set)
            .label("Simplicity")
            .checking("plain language");
    }
}

#[cfg(test)]
#[path = "simplicity_tests.rs"]
mod tests;