poexam 0.0.9

Blazingly fast PO linter.
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

// SPDX-FileCopyrightText: 2026 Sébastien Helleu <flashcode@flashtux.org>
//
// SPDX-License-Identifier: GPL-3.0-or-later

//! Implementation of the `blank` rule: check blank translation.

use crate::checker::Checker;
use crate::diagnostic::{Diagnostic, Severity};
use crate::po::entry::Entry;
use crate::po::message::Message;
use crate::rules::rule::RuleChecker;

pub struct BlankRule;

impl RuleChecker for BlankRule {
    fn name(&self) -> &'static str {
        "blank"
    }

    fn is_default(&self) -> bool {
        true
    }

    fn is_check(&self) -> bool {
        true
    }

    fn severity(&self) -> Severity {
        Severity::Warning
    }

    /// Check for blank translation (only whitespace).
    ///
    /// As the translation is not empty, it is used and it does not contain the appropriate
    /// translated text.
    ///
    /// Wrong entry:
    /// ```text
    /// msgid "this is a test"
    /// msgstr " "
    /// ```
    ///
    /// Correct entry:
    /// ```text
    /// msgid "this is a test"
    /// msgstr "ceci est un test"
    /// ```
    ///
    /// Diagnostics reported with severity [`warning`](Severity::Warning):
    /// - `blank translation`
    fn check_msg(
        &self,
        checker: &Checker,
        _entry: &Entry,
        msgid: &Message,
        msgstr: &Message,
    ) -> Vec<Diagnostic> {
        if !msgid.value.trim().is_empty()
            && !msgstr.value.is_empty()
            && msgstr.value.trim().is_empty()
        {
            vec![
                self.new_diag(checker, "blank translation".to_string())
                    .with_msgs_hl(msgid, &[], msgstr, &[(0, msgstr.value.len())]),
            ]
        } else {
            vec![]
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{diagnostic::Diagnostic, rules::rule::Rules};

    fn check_blank(content: &str) -> Vec<Diagnostic> {
        let mut checker = Checker::new(content.as_bytes());
        let rules = Rules::new(vec![Box::new(BlankRule {})]);
        checker.do_all_checks(&rules);
        checker.diagnostics
    }

    #[test]
    fn test_no_blank() {
        let diags = check_blank(
            r#"
msgid "tested"
msgstr "testé"
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_blank_id_and_str_ok() {
        let diags = check_blank(
            r#"
msgid "  "
msgstr "  "
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_blank_error_noqa() {
        let diags = check_blank(
            r#"
#, noqa:blank
msgid "tested"
msgstr "  "
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_blank_error() {
        let diags = check_blank(
            r#"
msgid "tested"
msgstr "  "
"#,
        );
        assert_eq!(diags.len(), 1);
        let diag = &diags[0];
        assert_eq!(diag.severity, Severity::Warning);
        assert_eq!(diag.message, "blank translation");
    }
}