harper-core 2.13.0

The language checker for developers.
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
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

use crate::{
    expr::{ExprExt, SequenceExpr},
    linting::{Lint, LintKind, Linter},
    {Document, Punctuation, TokenKind, TokenStringExt},
};

pub struct QuoteSpacing {
    expr: SequenceExpr,
}

impl QuoteSpacing {
    pub fn new() -> Self {
        Self {
            expr: SequenceExpr::any_word().then_quote().then_any_word(),
        }
    }
}

impl Default for QuoteSpacing {
    fn default() -> Self {
        Self::new()
    }
}

impl Linter for QuoteSpacing {
    fn lint(&mut self, document: &Document) -> Vec<Lint> {
        let mut lints = Vec::new();

        for m in self.expr.iter_matches_in_doc(document) {
            let matched_tokens = m.get_content(document.get_tokens());

            let Some(_span) = matched_tokens.span() else {
                continue;
            };

            let quote_tok = &matched_tokens[1];

            // Is this an opening or closing quote?
            let quote_index = m.start + 1; // Quote is the second token in the match
            let is_closing = if let TokenKind::Punctuation(Punctuation::Quote(q)) = quote_tok.kind {
                // If twin_loc points backward, this is a closing quote
                q.twin_loc.is_some_and(|twin| twin < quote_index)
            } else {
                false
            };

            let mut suggestions = vec![
                super::Suggestion::ReplaceWith(vec![' ', '"']),
                super::Suggestion::ReplaceWith(vec!['"', ' ']),
            ];

            // For closing quotes, space likely should be after it
            if is_closing {
                suggestions.swap(0, 1);
            }

            lints.push(Lint {
                span: matched_tokens[1].span,
                lint_kind: LintKind::Formatting,
                suggestions,
                message: "A quote must be preceded or succeeded by a space.".to_owned(),
                priority: 31,
            })
        }

        lints
    }

    fn description(&self) -> &str {
        "Checks that quotation marks are preceded or succeeded by whitespace."
    }
}

#[cfg(test)]
mod tests {
    use super::QuoteSpacing;
    use crate::linting::tests::{
        assert_first_suggestion_result, assert_lint_count, assert_no_lints,
        assert_suggestion_result,
    };

    #[test]
    fn flags_missing_space_before_quote() {
        assert_lint_count("He said\"hello\" to me.", QuoteSpacing::default(), 1);
    }

    #[test]
    fn flags_missing_space_after_quote() {
        assert_lint_count(
            "She whispered \"hurry\"and left.",
            QuoteSpacing::default(),
            1,
        );
    }

    #[test]
    fn allows_quotes_with_spacing() {
        assert_no_lints("They shouted \"charge\" together.", QuoteSpacing::default());
    }

    #[test]
    fn allows_quotes_at_end_of_sentence() {
        assert_no_lints("They shouted \"charge.\"", QuoteSpacing::default());
    }

    #[test]
    fn fix_by_inserting_space_after() {
        assert_suggestion_result(
            "It's not a complete sentence since it lacks a verb but it would be valid as a title or answer to a question since \"dog runs\"are things which exist",
            QuoteSpacing::default(),
            "It's not a complete sentence since it lacks a verb but it would be valid as a title or answer to a question since \"dog runs\" are things which exist",
        );
    }

    #[test]
    fn ensure_first_suggestion_is_space_then_quote() {
        assert_first_suggestion_result(
            "foo\"bar\" bar",
            QuoteSpacing::default(),
            "foo \"bar\" bar",
        );
    }

    #[test]
    fn ensure_first_suggestion_is_quote_then_space() {
        assert_first_suggestion_result(
            "foo \"bar\"bar",
            QuoteSpacing::default(),
            "foo \"bar\" bar",
        );
    }

    #[test]
    #[should_panic]
    fn ensure_first_suggestion_is_not_quote_then_space() {
        assert_first_suggestion_result(
            "foo \"bar\"bar",
            QuoteSpacing::default(),
            "foo\" bar\" bar",
        );
    }

    #[test]
    fn ensure_quote_then_space_is_suggested_even_when_wrong() {
        assert_suggestion_result("foo\"bar\" bar", QuoteSpacing::default(), "foo\" bar\" bar");
    }
}