poexam 0.0.10

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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

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

//! Implementation of the `double-spaces` rule: check missing/extra double spaces.

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 DoubleSpacesRule;

impl RuleChecker for DoubleSpacesRule {
    fn name(&self) -> &'static str {
        "double-spaces"
    }

    fn description(&self) -> &'static str {
        "Check for missing or extra double spaces in translation."
    }

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

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

    /// Check for missing or extra double spaces in the translation.
    ///
    /// Wrong entry:
    /// ```text
    /// msgid "the test:  \"xyz\""
    /// msgstr "le test : \"xyz\""
    /// ```
    ///
    /// Correct entry:
    /// ```text
    /// msgid "the test:  \"xyz\""
    /// msgstr "le test :  \"xyz\""
    /// ```
    ///
    /// Diagnostics reported:
    /// - [`info`](Severity::Info): `missing double spaces '  ' (# / #)`
    /// - [`info`](Severity::Info): `extra double spaces '  ' (# / #)`
    fn check_msg(
        &self,
        checker: &Checker,
        _entry: &Entry,
        msgid: &Message,
        msgstr: &Message,
    ) -> Vec<Diagnostic> {
        let id_count = msgid.value.matches("  ").count();
        let str_count = msgstr.value.matches("  ").count();
        let msg = match id_count.cmp(&str_count) {
            std::cmp::Ordering::Equal => return vec![],
            std::cmp::Ordering::Greater => {
                format!("missing double spaces '  ' ({id_count} / {str_count})")
            }
            std::cmp::Ordering::Less => {
                format!("extra double spaces '  ' ({id_count} / {str_count})")
            }
        };
        self.new_diag(checker, Severity::Info, msg)
            .map(|d| {
                d.with_msgs_hl(
                    msgid,
                    msgid
                        .value
                        .match_indices("  ")
                        .map(|(idx, value)| (idx, idx + value.len())),
                    msgstr,
                    msgstr
                        .value
                        .match_indices("  ")
                        .map(|(idx, value)| (idx, idx + value.len())),
                )
            })
            .into_iter()
            .collect()
    }
}

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

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

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

    #[test]
    fn test_double_spaces_ok() {
        let diags = check_double_spaces(
            r#"
msgid "this  is  a  test"
msgstr "ceci  est  un  test"
"#,
        );
        // Note: leading and trailing and double spaces are ignored here
        // (such errors are reported in the "whitespace" checks).
        assert!(diags.is_empty());
    }

    #[test]
    fn test_double_spaces_error_noqa() {
        let diags = check_double_spaces(
            r#"
#, noqa:double-spaces
msgid "this is a  test"
msgstr "ceci est un test"
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_double_spaces_error() {
        let diags = check_double_spaces(
            r#"
msgid "this is a  test"
msgstr "ceci est un test"

msgid "this is a test"
msgstr "ceci est un  test"
"#,
        );
        assert_eq!(diags.len(), 2);
        let diag = &diags[0];
        assert_eq!(diag.severity, Severity::Info);
        assert_eq!(diag.message, "missing double spaces '  ' (1 / 0)");
        let diag = &diags[1];
        assert_eq!(diag.severity, Severity::Info);
        assert_eq!(diag.message, "extra double spaces '  ' (0 / 1)");
    }
}