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

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

//! Implementation of the `double-words` rule: check for consecutive repeated words.

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

pub struct DoubleWordsRule;

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

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

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

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

    /// Check for double consecutive words in the translation.
    ///
    /// This rule is not enabled by default.
    ///
    /// Wrong entry:
    /// ```text
    /// msgid "This is a test"
    /// msgstr "Ceci est un un test"
    /// ```
    ///
    /// Correct entry:
    /// ```text
    /// msgid "This is a test"
    /// msgstr "Ceci est un test"
    /// ```
    ///
    /// Diagnostics reported with severity [`info`](Severity::Info):
    /// - `word 'xxx' is repeated`
    fn check_msg(
        &self,
        checker: &Checker,
        entry: &Entry,
        msgid: &Message,
        msgstr: &Message,
    ) -> Vec<Diagnostic> {
        let mut diags = vec![];
        let mut words_iter = FormatWordPos::new(&msgstr.value, &entry.format_language).peekable();
        while let Some(word) = words_iter.next()
            && let Some(next_word) = words_iter.peek()
        {
            // If the current word is the same as the next word, and that there is only
            // whitespace between them, then report a double word.
            if word.s == next_word.s
                && msgstr.value[word.end..next_word.start]
                    .chars()
                    .all(char::is_whitespace)
            {
                diags.push(
                    self.new_diag(checker, format!("word '{}' is repeated", word.s))
                        .with_msgs_hl(msgid, &[], msgstr, &[(word.start, next_word.end)]),
                );
            }
        }
        diags
    }
}

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

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

    #[test]
    fn test_no_double_words() {
        let diags = check_double_words(
            r#"
msgid "this is a test"
msgstr "ceci est un test"
"#,
        );
        assert!(diags.is_empty());
    }

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

    #[test]
    fn test_double_words_error() {
        let diags = check_double_words(
            r#"
msgid "this is a test"
msgstr "ceci est un un test"
"#,
        );
        assert_eq!(diags.len(), 1);
        let diag = &diags[0];
        assert_eq!(diag.severity, Severity::Info);
        assert_eq!(diag.message, "word 'un' is repeated");
    }
}