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

use codebook::queries::LanguageType;

use super::utils::assert_spelling;

#[test]
fn test_r_simple() {
    let sample_text = r#"
       calculatr <- function(numbr1, argumnt2=3) {
           # This is an exampl function
           numberr1 + argument2
       }
    "#;
    // Identifiers used in the function body ("numberr1") are not checked;
    // only assignments, parameters, comments, and strings are.
    assert_spelling(
        LanguageType::R,
        sample_text,
        &["argumnt", "calculatr", "exampl", "numbr"],
        &["numberr"],
    );
}

#[test]
fn test_r_string() {
    let sample_text = r#"
        my_var <- "herlo, world"
    "#;
    assert_spelling(LanguageType::R, sample_text, &["herlo"], &[]);
}

#[test]
fn test_r_kwarg() {
    let sample_text = r#"
        table2 <- dplyr::mutate(table1, mispell=nmae1 + name2, bad_spelin, olny_named_cols=3)
    "#;
    // Only keyword argument names are checked; argument values ("nmae1")
    // and positional arguments ("bad_spelin") are not.
    assert_spelling(
        LanguageType::R,
        sample_text,
        &["mispell", "olny"],
        &["nmae", "spelin"],
    );
}

#[test]
fn test_r_assign() {
    let sample_text = r#"
        list$miispell = list()
        list$mispell$chiian <- 1
        list$mispell$chainn[1:3] <- 2 # Should not get checked
        list$ingore@atsigns = 3
        4 -> right@atsigns$wroks
        lerft -> rihgt # Only right-side gets checked
        leeft <- 3
        lefft = 2
    "#;
    assert_spelling(
        LanguageType::R,
        sample_text,
        &["chiian", "leeft", "lefft", "miispell", "rihgt", "wroks"],
        &["chainn", "ingore", "lerft"],
    );
}