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
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
148
149
150
151

use codebook::queries::LanguageType;

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

#[test]
fn test_latex_comments() {
    let sample_text = r#"
% This is a coment with a typo
% Another commnet with wrng spelling
\documentclass{article}
    "#;
    // Command names (\documentclass) and their arguments are not checked.
    assert_spelling(
        LanguageType::Latex,
        sample_text,
        &["coment", "commnet", "wrng"],
        &["documentclass", "article"],
    );
}

#[test]
fn test_latex_text_content() {
    let sample_text = r#"
\section{Introducton}

This is an exampl of text with speling errors.
    "#;
    assert_spelling(
        LanguageType::Latex,
        sample_text,
        &["Introducton", "exampl", "speling"],
        &[],
    );
}

#[test]
fn test_latex_sections_and_text() {
    let sample_text = r#"
\section{Methology}

The methology section describs the approach.

\subsection{Bakground}

In this secion we discuss importnt concepts.
    "#;
    assert_spelling(
        LanguageType::Latex,
        sample_text,
        &[
            "Bakground",
            "Methology",
            "describs",
            "importnt",
            "methology",
            "secion",
        ],
        &[],
    );
}

#[test]
fn test_latex_itemize() {
    let sample_text = r#"
\begin{itemize}
    \item First itm with algoritm
    \item Second itm about formulas
\end{itemize}
    "#;
    // "itm" appears in both \item lines and is flagged at both; occurrence 1
    // is the substring inside "algoritm", which is flagged as its own word.
    assert_spelling_at(
        LanguageType::Latex,
        sample_text,
        &[("algoritm", &[0]), ("itm", &[0, 2])],
    );
}

#[test]
fn test_latex_mixed_content() {
    let sample_text = r#"
% Comment: calcuate the result
\section{Resuts}

The resuts show our aproach is efective.

\begin{equation}
    E = mc^2 \label{eq:enrgy}
\end{equation}

As shown in Equation~\ref{eq:enrgy}, the relatioship is clear.
    "#;
    // Exact set equality: command names (equation, label, ref, begin, end,
    // section) can't appear in the flagged set. Label names ARE checked:
    // "enrgy" is flagged both in \label and \ref.
    assert_spelling_at(
        LanguageType::Latex,
        sample_text,
        &[
            ("Resuts", &[0]),
            ("aproach", &[0]),
            ("calcuate", &[0]),
            ("efective", &[0]),
            ("enrgy", &[0, 1]),
            ("relatioship", &[0]),
            ("resuts", &[0]),
        ],
    );
}

#[test]
fn test_latex_comprehensive() {
    let sample_text = r#"
\documentclass{article}

% This coment has typos: wrng and speling
\title{A Sampel Document}

\begin{document}

\section{Introducton}

This docment demonstrates the spel checker.

\subsection{Analyss}

The analyss reveals paterns in the data.

\end{document}
    "#;
    // Exact set equality: command names (documentclass, article, title,
    // begin, end, document, section, subsection) can't appear in the flagged
    // set. "spel" also occurs inside "speling" (occurrence 0); only the
    // standalone word is flagged as "spel".
    assert_spelling_at(
        LanguageType::Latex,
        sample_text,
        &[
            ("Analyss", &[0]),
            ("Introducton", &[0]),
            ("Sampel", &[0]),
            ("analyss", &[0]),
            ("coment", &[0]),
            ("docment", &[0]),
            ("paterns", &[0]),
            ("spel", &[1]),
            ("speling", &[0]),
            ("wrng", &[0]),
        ],
    );
}