codebook 0.3.42

A code-aware spell checker library (dependency for codebook-lsp)
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

use codebook::queries::LanguageType;

use super::utils::{assert_spelling, assert_spelling_at};

#[test]
fn test_swift_simple() {
    let sample_text = r#"
        // Misspell on a sepaate line
        class Object { // comment at the end of the lne
            // Comment can be inented
            func bar() {
            }
            func opttions() {
            }
        }

        /* func foobar()
         * {
         * These wors are
         * comented out but should be identified
         */

        func doStuff(_ nunber: Int)
        {
        }
        func doMoar(_ nunber: Int)
        {
        }
        func doAgain(frm: number: Int)
        {
        }
        class Foo2 {
        class MyThig {
        }

        // frozen_string_lteral: true

        var x = "helo"

        protocol enumrable {
        }
    "#;
    assert_spelling_at(
        LanguageType::Swift,
        sample_text,
        &[
            ("sepaate", &[0]),
            ("lne", &[0]),
            ("inented", &[0]),
            ("opttions", &[0]),
            // Block-comment contents are checked.
            ("wors", &[0]),
            ("comented", &[0]),
            // Both parameter definitions (doStuff and doMoar) are flagged.
            ("nunber", &[0, 1]),
            ("Moar", &[0]),
            ("frm", &[0]),
            ("Thig", &[0]),
            ("lteral", &[0]),
            ("helo", &[0]),
            ("enumrable", &[0]),
        ],
    );
}

#[test]
fn test_swift_code() {
    let sample_text = r#"
func send_notfication(to recipient: String, _ subject: String, body: String)
{
    // This method sends an email with potentialy misspelled content
    let email = Email(to: recipient,
        subject: "URGENT: #{subject}",
        body: "Dear valued custommer,\n\n#{body}\n\nRegads,\nSuport Team")
    email.send()
}

if status == "complette" || status == "partialy_compleet" {
    mark_as_finnished(item)
}
        "#;
    assert_spelling(
        LanguageType::Swift,
        sample_text,
        &[
            "notfication",
            "potentialy",
            "custommer",
            "Regads",
            "Suport",
            "complette",
            // Split from the string "partialy_compleet".
            "partialy",
            "compleet",
        ],
        // Function-call references are not spell-checked.
        &["finnished"],
    );
}