codebook 0.3.37

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

use codebook::{
    Codebook,
    parser::{TextRange, WordLocation},
    queries::LanguageType,
};
use codebook_config::{CodebookConfig, CodebookConfigMemory};
use std::sync::Arc;

pub fn get_processor(words: Option<&[&str]>) -> Codebook {
    let config = Arc::new(CodebookConfigMemory::default());
    if let Some(words) = words {
        for w in words {
            let _ = config.add_word(w);
        }
    }
    Codebook::new(config).unwrap()
}

#[test]
fn test_custom_words() {
    let sample_text = r#"
        ok words
        testword
        good words
        actualbad
"#;
    let expected = vec![WordLocation::new(
        "actualbad".to_string(),
        vec![TextRange {
            start_byte: 62,
            end_byte: 71,
        }],
    )];
    let not_expected = ["testword"];
    let processor = get_processor(Some(&not_expected));
    let misspelled = processor
        .spell_check(sample_text, Some(LanguageType::Text), None)
        .to_vec();
    println!("Misspelled words: {misspelled:?}");
    assert_eq!(misspelled, expected);
    assert!(misspelled[0].locations.len() == 1);
    for result in misspelled {
        assert!(!not_expected.contains(&result.word.as_str()));
    }
}