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

//! Prohibited terms check — flags configured prohibited terms found in prose.

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

use crate::check::Check;

/// Checks that none of the configured prohibited terms appear in the document.
///
/// Terms may be single words or multi-word phrases. Matching is
/// case-insensitive. Matches in code blocks and list items are ignored.
#[derive(Debug)]
pub struct ProhibitedTermsCheck;

impl Check for ProhibitedTermsCheck {
    fn id(&self) -> &'static str {
        "prohibited-terms"
    }

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

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

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

        let evidence = super::collect_prohibited_term_evidence(doc, &prohibited_terms);
        let observed = super::unique_matched_texts(&evidence);
        let _result = suite
            .record_custom_values(
                "prohibited-terms",
                evidence.is_empty(),
                json!({ "absent": prohibited_terms }),
                json!(observed),
                &evidence,
            )
            .label("Prohibited Terms")
            .checking("prohibited terms in prose");
    }
}

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