codebook 0.3.39

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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use codebook::{
    parser::{TextRange, WordLocation},
    queries::LanguageType,
};


#[test]
fn test_yaml_simple() {
    super::utils::init_logging();
    let processor = super::utils::get_processor();
    let sample_text = r#"
      # On a sepaate line
      title: "Example lne"
      nested:
        name: Naame
        nested:
          item_name: Iteem name
      details: |
        # can be inented
        This is comented out
        this wors, too
      options:
        - opttions
        - parameters
      flags: froozen
      var: 'helo'
      symbol: ':hello'
    "#;
    let expected = vec![
        "Iteem", "Naame", "comented", "froozen", "helo", "inented", "lne", "opttions", "sepaate",
        "wors",
    ];
    let binding = processor
        .spell_check(sample_text, Some(LanguageType::YAML), None)
        .to_vec();
    let mut misspelled = binding
        .iter()
        .map(|r| r.word.as_str())
        .collect::<Vec<&str>>();
    misspelled.sort();
    println!("Misspelled words: {misspelled:?}");
    assert_eq!(misspelled, expected);
}

#[test]
fn test_yaml_code() {
    super::utils::init_logging();
    let sample_yaml_code = r#"
      # On a separate line
      tiitle: "Example line"
      subtiitle: Subtitle
      descriptioon: 'hello'
      nested_struucture:
        name: "Name"
        nestted:
          item_name: 'Item name'
          another_name: Another Name
      options:
        - parameters:
        - parameters
      items: [ { id: 1, naame: "one" }, { id: 2, name: "two" } ]

    "#;

    let expected = vec![
        WordLocation::new(
            "tiitle".to_string(),
            vec![TextRange {
                start_byte: 34,
                end_byte: 40,
            }],
        ),
        WordLocation::new(
            "subtiitle".to_string(),
            vec![TextRange {
                start_byte: 63,
                end_byte: 72,
            }],
        ),
        WordLocation::new(
            "descriptioon".to_string(),
            vec![TextRange {
                start_byte: 89,
                end_byte: 101,
            }],
        ),
        WordLocation::new(
            "struucture".to_string(),
            vec![TextRange {
                start_byte: 124,
                end_byte: 134,
            }],
        ),
        WordLocation::new(
            "nestted".to_string(),
            vec![TextRange {
                start_byte: 165,
                end_byte: 172,
            }],
        ),
        WordLocation::new(
            "naame".to_string(),
            vec![TextRange {
                start_byte: 326,
                end_byte: 331,
            }],
        ),
    ];
    let processor = super::utils::get_processor();
    let misspelled = processor
        .spell_check(sample_yaml_code, Some(LanguageType::YAML), None)
        .to_vec();
    println!("Misspelled words: {misspelled:?}");
    for e in &expected {
        let miss = misspelled.iter().find(|r| r.word == e.word).unwrap();
        println!("Expecting: {e:?}");
        assert_eq!(miss.locations, e.locations);
    }
}