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
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
use std::str::FromStr;

use tree_sitter::Language;

#[derive(Debug, Clone, PartialEq, Eq, Hash, Copy)]
pub enum LanguageType {
    Bash,
    C,
    CSharp,
    Cpp,
    Css,
    Dart,
    Elixir,
    Erlang,
    Go,
    HTML,
    Haskell,
    Java,
    Javascript,
    Latex,
    Lua,
    Markdown,
    OCaml,
    Odin,
    Php,
    Python,
    R,
    Ruby,
    Rust,
    Swift,
    TOML,
    Text,
    Typescript,
    Tsx,
    Typst,
    VHDL,
    YAML,
    Zig,
}

impl FromStr for LanguageType {
    type Err = ();
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        for language in LANGUAGE_SETTINGS.iter() {
            for id in language.ids.iter() {
                if s == *id {
                    return Ok(language.type_);
                }
            }
            for ext in language.extensions.iter() {
                if s == *ext {
                    return Ok(language.type_);
                }
            }
        }
        Ok(LanguageType::Text)
    }
}

impl LanguageType {
    pub fn dictionary_ids(&self) -> Vec<String> {
        for language in LANGUAGE_SETTINGS.iter() {
            if self == &language.type_ {
                return language
                    .dictionary_ids
                    .iter()
                    .map(|s| s.to_string())
                    .collect();
            }
        }
        vec![]
    }
}

// Language ids documented at https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentItem
pub static LANGUAGE_SETTINGS: &[LanguageSetting] = &[
    LanguageSetting {
        type_: LanguageType::Rust,
        ids: &["rust"],
        dictionary_ids: &["rust"],
        query: include_str!("queries/rust.scm"),
        extensions: &["rs"],
    },
    LanguageSetting {
        type_: LanguageType::C,
        ids: &["c"],
        dictionary_ids: &["c"],
        query: include_str!("queries/c.scm"),
        extensions: &["c", "h"],
    },
    LanguageSetting {
        type_: LanguageType::Cpp,
        ids: &["cpp", "c++"],
        dictionary_ids: &["cpp"],
        query: include_str!("queries/cpp.scm"),
        extensions: &["cpp", "cc", "cxx", "hpp", "hh", "hxx", "cppm", "ixx", "mxx"],
    },
    LanguageSetting {
        type_: LanguageType::Elixir,
        ids: &["elixir"],
        dictionary_ids: &["elixir"],
        query: include_str!("queries/elixir.scm"),
        extensions: &["ex", "exs"],
    },
    LanguageSetting {
        type_: LanguageType::Erlang,
        ids: &["erlang"],
        dictionary_ids: &["erlang"],
        query: include_str!("queries/erlang.scm"),
        extensions: &["erl", "hrl"],
    },
    LanguageSetting {
        type_: LanguageType::Python,
        ids: &["python"],
        dictionary_ids: &["python"],
        query: include_str!("queries/python.scm"),
        extensions: &["py"],
    },
    LanguageSetting {
        type_: LanguageType::Java,
        ids: &["java"],
        dictionary_ids: &["java"],
        query: include_str!("queries/java.scm"),
        extensions: &["java"],
    },
    LanguageSetting {
        type_: LanguageType::Javascript,
        ids: &["javascript", "javascriptreact", "jsx"],
        dictionary_ids: &["javascript", "javascriptreact"],
        query: include_str!("queries/javascript.scm"),
        extensions: &["js", "jsx"],
    },
    LanguageSetting {
        type_: LanguageType::Latex,
        ids: &["latex"],
        dictionary_ids: &["latex"],
        query: include_str!("queries/latex.scm"),
        extensions: &["tex", "latex", "ltx"],
    },
    LanguageSetting {
        type_: LanguageType::Typescript,
        ids: &["typescript"],
        dictionary_ids: &["typescript"],
        query: include_str!("queries/typescript.scm"),
        extensions: &["ts"],
    },
    LanguageSetting {
        type_: LanguageType::Tsx,
        ids: &["typescriptreact", "tsx"],
        dictionary_ids: &["typescriptreact"],
        query: include_str!("queries/typescript.scm"),
        extensions: &["tsx"],
    },
    LanguageSetting {
        type_: LanguageType::Haskell,
        ids: &["hs"],
        dictionary_ids: &["haskell"],
        query: include_str!("queries/haskell.scm"),
        extensions: &["hs"],
    },
    LanguageSetting {
        type_: LanguageType::HTML,
        ids: &["html", "vue", "vue.js", "astro", "svelte"],
        dictionary_ids: &["html"],
        query: include_str!("queries/html.scm"),
        extensions: &["html", "htm", "vue", "astro", "svelte"],
    },
    LanguageSetting {
        type_: LanguageType::Css,
        ids: &["css"],
        dictionary_ids: &["css"],
        query: include_str!("queries/css.scm"),
        extensions: &["css"],
    },
    LanguageSetting {
        type_: LanguageType::Dart,
        ids: &["dart"],
        dictionary_ids: &["dart"],
        query: include_str!("queries/dart.scm"),
        extensions: &["dart"],
    },
    LanguageSetting {
        type_: LanguageType::Go,
        ids: &["go"],
        dictionary_ids: &["go"],
        query: include_str!("queries/go.scm"),
        extensions: &["go"],
    },
    LanguageSetting {
        type_: LanguageType::Swift,
        ids: &["swift"],
        dictionary_ids: &["swift"],
        query: include_str!("queries/swift.scm"),
        extensions: &["swift"],
    },
    LanguageSetting {
        type_: LanguageType::TOML,
        ids: &["toml"],
        dictionary_ids: &["toml"],
        query: include_str!("queries/toml.scm"),
        extensions: &["toml"],
    },
    LanguageSetting {
        type_: LanguageType::Ruby,
        ids: &["ruby"],
        dictionary_ids: &["ruby"],
        query: include_str!("queries/ruby.scm"),
        extensions: &["rb"],
    },
    LanguageSetting {
        type_: LanguageType::Lua,
        ids: &["lua"],
        dictionary_ids: &["lua"],
        query: include_str!("queries/lua.scm"),
        extensions: &["lua"],
    },
    LanguageSetting {
        type_: LanguageType::Markdown,
        ids: &["markdown"],
        dictionary_ids: &[],
        query: include_str!("queries/markdown.scm"),
        extensions: &["md", "markdown"],
    },
    LanguageSetting {
        type_: LanguageType::Bash,
        ids: &[
            "bash",
            "shellscript",
            "sh",
            "shell script",
            "shell",
            "zsh",
            "fish",
        ],
        dictionary_ids: &["bash"],
        query: include_str!("queries/bash.scm"),
        extensions: &["sh", "bash"],
    },
    LanguageSetting {
        type_: LanguageType::OCaml,
        ids: &["ocaml"],
        dictionary_ids: &["ocaml"],
        query: include_str!("queries/ocaml.scm"),
        extensions: &["ml", "mli"],
    },
    LanguageSetting {
        type_: LanguageType::Odin,
        ids: &["odin"],
        dictionary_ids: &["odin"],
        query: include_str!("queries/odin.scm"),
        extensions: &["odin"],
    },
    LanguageSetting {
        type_: LanguageType::Php,
        ids: &["php"],
        dictionary_ids: &["php"],
        query: include_str!("queries/php.scm"),
        extensions: &["php"],
    },
    LanguageSetting {
        type_: LanguageType::R,
        ids: &["r"],
        dictionary_ids: &["r"],
        query: include_str!("queries/r.scm"),
        extensions: &["r", "R"],
    },
    LanguageSetting {
        type_: LanguageType::YAML,
        ids: &["yaml", "yml"],
        dictionary_ids: &["yaml"],
        query: include_str!("queries/yaml.scm"),
        extensions: &["yaml", "yml"],
    },
    LanguageSetting {
        type_: LanguageType::Zig,
        ids: &["zig"],
        dictionary_ids: &["zig"],
        query: include_str!("queries/zig.scm"),
        extensions: &["zig"],
    },
    LanguageSetting {
        type_: LanguageType::CSharp,
        ids: &["csharp"],
        dictionary_ids: &["csharp"],
        query: include_str!("queries/csharp.scm"),
        extensions: &["cs"],
    },
    LanguageSetting {
        type_: LanguageType::Typst,
        ids: &["typst"],
        dictionary_ids: &["typst"],
        query: include_str!("queries/typst.scm"),
        extensions: &["typ"],
    },
    LanguageSetting {
        type_: LanguageType::VHDL,
        ids: &["vhdl"],
        dictionary_ids: &["vhdl"],
        query: include_str!("queries/vhdl.scm"),
        extensions: &["vhd", "vhdl"],
    },
];

#[derive(Debug)]
pub struct LanguageSetting {
    pub type_: LanguageType,
    pub query: &'static str,
    /// ID from https://code.visualstudio.com/docs/languages/identifiers
    pub ids: &'static [&'static str],
    pub dictionary_ids: &'static [&'static str],
    pub extensions: &'static [&'static str],
}

impl LanguageSetting {
    pub fn language(&self) -> Option<Language> {
        match self.type_ {
            LanguageType::Bash => Some(tree_sitter_bash::LANGUAGE.into()),
            LanguageType::C => Some(tree_sitter_c::LANGUAGE.into()),
            LanguageType::CSharp => Some(tree_sitter_c_sharp::LANGUAGE.into()),
            LanguageType::Cpp => Some(tree_sitter_cpp::LANGUAGE.into()),
            LanguageType::Css => Some(tree_sitter_css::LANGUAGE.into()),
            LanguageType::Dart => Some(tree_sitter_dart::LANGUAGE.into()),
            LanguageType::Elixir => Some(tree_sitter_elixir::LANGUAGE.into()),
            LanguageType::Erlang => Some(tree_sitter_erlang::LANGUAGE.into()),
            LanguageType::Go => Some(tree_sitter_go::LANGUAGE.into()),
            LanguageType::HTML => Some(tree_sitter_html::LANGUAGE.into()),
            LanguageType::Haskell => Some(tree_sitter_haskell::LANGUAGE.into()),
            LanguageType::Java => Some(tree_sitter_java::LANGUAGE.into()),
            LanguageType::Javascript => Some(tree_sitter_javascript::LANGUAGE.into()),
            LanguageType::Latex => Some(codebook_tree_sitter_latex::LANGUAGE.into()),
            LanguageType::Lua => Some(tree_sitter_lua::LANGUAGE.into()),
            LanguageType::Markdown => Some(tree_sitter_md::LANGUAGE.into()),
            LanguageType::OCaml => Some(tree_sitter_ocaml::LANGUAGE_OCAML.into()),
            LanguageType::Odin => Some(tree_sitter_odin_codebook::LANGUAGE.into()),
            LanguageType::Php => Some(tree_sitter_php::LANGUAGE_PHP.into()),
            LanguageType::Python => Some(tree_sitter_python::LANGUAGE.into()),
            LanguageType::R => Some(tree_sitter_r::LANGUAGE.into()),
            LanguageType::Ruby => Some(tree_sitter_ruby::LANGUAGE.into()),
            LanguageType::Rust => Some(tree_sitter_rust::LANGUAGE.into()),
            LanguageType::Swift => Some(tree_sitter_swift::LANGUAGE.into()),
            LanguageType::TOML => Some(tree_sitter_toml_ng::LANGUAGE.into()),
            LanguageType::Text => None,
            LanguageType::Typescript => Some(tree_sitter_typescript::LANGUAGE_TYPESCRIPT.into()),
            LanguageType::Tsx => Some(tree_sitter_typescript::LANGUAGE_TSX.into()),
            LanguageType::Typst => Some(codebook_tree_sitter_typst::LANGUAGE.into()),
            LanguageType::VHDL => Some(tree_sitter_vhdl::LANGUAGE.into()),
            LanguageType::YAML => Some(tree_sitter_yaml::LANGUAGE.into()),
            LanguageType::Zig => Some(tree_sitter_zig::LANGUAGE.into()),
        }
    }
}

pub fn get_language_setting(language_type: LanguageType) -> Option<&'static LanguageSetting> {
    LANGUAGE_SETTINGS
        .iter()
        .find(|&setting| setting.type_ == language_type && setting.language().is_some())
}

pub fn get_language_name_from_filename(filename: &str) -> LanguageType {
    let extension = filename.split('.').next_back().unwrap();
    for setting in LANGUAGE_SETTINGS {
        for ext in setting.extensions {
            if ext == &extension {
                return setting.type_;
            }
        }
    }
    LanguageType::Text
}

#[cfg(test)]
mod tests {
    use super::*;
    use tree_sitter::Query;

    #[test]
    fn test_all_queries_are_valid() {
        for language_setting in LANGUAGE_SETTINGS {
            // Skip testing Text since it doesn't have a language or query
            if language_setting.type_ == LanguageType::Text {
                continue;
            }

            // Get the language for this setting
            let language = match language_setting.language() {
                Some(lang) => lang,
                None => {
                    panic!("Failed to get language for {:?}", language_setting.type_);
                }
            };

            // Try to create a Query with the language and query
            let query_result = Query::new(&language, language_setting.query);

            // Assert that the query is valid
            assert!(
                query_result.is_ok(),
                "Invalid query for language {:?}: {:?}",
                language_setting.type_,
                query_result.err()
            );
        }
    }

    /// Allowed full capture names. Any capture in a .scm file must be one of these.
    /// The special "language" tag is used internally (e.g., ruby heredocs) and is
    /// not exposed for user filtering.
    const ALLOWED_TAGS: &[&str] = &[
        "comment",
        "comment.line",
        "comment.block",
        "string",
        "string.special",
        "string.heredoc",
        "identifier",
        "identifier.function",
        "identifier.type",
        "identifier.parameter",
        "identifier.field",
        "identifier.variable",
        "identifier.constant",
        "identifier.module",
        "language",
    ];

    #[test]
    fn test_all_capture_names_use_allowed_tags() {
        for language_setting in LANGUAGE_SETTINGS {
            if language_setting.type_ == LanguageType::Text {
                continue;
            }

            let language = language_setting.language().unwrap_or_else(|| {
                panic!("Failed to get language for {:?}", language_setting.type_)
            });

            let query = Query::new(&language, language_setting.query).unwrap_or_else(|e| {
                panic!(
                    "Invalid query for language {:?}: {:?}",
                    language_setting.type_, e
                )
            });

            for name in query.capture_names() {
                let is_allowed = ALLOWED_TAGS.contains(name) || name.starts_with("injection.");
                assert!(
                    is_allowed,
                    "Language {:?} uses unknown capture tag @{name}. \
                     Allowed tags: {ALLOWED_TAGS:?} (plus injection.* tags)",
                    language_setting.type_,
                );
            }
        }
    }

    #[test]
    fn test_no_overlap_in_ids_and_extensions() {
        use std::collections::HashMap;

        // Map every id and extension to the language that owns it
        let mut seen: HashMap<&str, LanguageType> = HashMap::new();

        for setting in LANGUAGE_SETTINGS {
            for &id in setting.ids {
                if let Some(&prev) = seen.get(id) {
                    panic!(
                        "Duplicate id/extension {id:?}: used by both {:?} and {:?}",
                        prev, setting.type_
                    );
                }
                seen.insert(id, setting.type_);
            }
            for &ext in setting.extensions {
                if let Some(&prev) = seen.get(ext) {
                    // Allow overlap within the same language (e.g. "hs" in both ids and extensions)
                    if prev != setting.type_ {
                        panic!(
                            "Duplicate id/extension {ext:?}: used by both {:?} and {:?}",
                            prev, setting.type_
                        );
                    }
                }
                seen.insert(ext, setting.type_);
            }
        }
    }
}