tree_sitter_typescript/lib.rs
1//! This crate provides TypeScript and TSX language support for the [tree-sitter][] parsing library.
2//!
3//! Typically, you will use the [LANGUAGE_TYPESCRIPT] constant to add this language to a
4//! tree-sitter [Parser][], and then use the parser to parse some code:
5//!
6//! ```
7//! use tree_sitter::Parser;
8//!
9//! let code = r#"
10//! function double(x: number): number {
11//! return x * 2;
12//! }
13//! "#;
14//! let mut parser = Parser::new();
15//! let language = tree_sitter_typescript::LANGUAGE_TYPESCRIPT;
16//! parser
17//! .set_language(&language.into())
18//! .expect("Error loading TypeScript parser");
19//! let tree = parser.parse(code, None).unwrap();
20//! assert!(!tree.root_node().has_error());
21//! ```
22//!
23//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
24//! [tree-sitter]: https://tree-sitter.github.io/
25
26use tree_sitter_language::LanguageFn;
27
28extern "C" {
29 fn tree_sitter_typescript() -> *const ();
30 fn tree_sitter_tsx() -> *const ();
31}
32
33/// The tree-sitter [`LanguageFn`] for TypeScript.
34///
35/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
36pub const LANGUAGE_TYPESCRIPT: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_typescript) };
37
38/// The tree-sitter [`LanguageFn`] for TSX.
39///
40/// [LanguageFn]: https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html
41pub const LANGUAGE_TSX: LanguageFn = unsafe { LanguageFn::from_raw(tree_sitter_tsx) };
42
43/// The content of the [`node-types.json`][] file for TypeScript.
44///
45/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
46pub const TYPESCRIPT_NODE_TYPES: &str = include_str!("../../typescript/src/node-types.json");
47
48/// The content of the [`node-types.json`][] file for TSX.
49///
50/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
51pub const TSX_NODE_TYPES: &str = include_str!("../../tsx/src/node-types.json");
52
53/// The syntax highlighting query for TypeScript.
54pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
55
56/// The local-variable syntax highlighting query for TypeScript.
57pub const LOCALS_QUERY: &str = include_str!("../../queries/locals.scm");
58
59/// The symbol tagging query for TypeScript.
60pub const TAGS_QUERY: &str = include_str!("../../queries/tags.scm");
61
62#[cfg(test)]
63mod tests {
64 #[test]
65 fn test_can_load_typescript_grammar() {
66 let mut parser = tree_sitter::Parser::new();
67 parser
68 .set_language(&super::LANGUAGE_TYPESCRIPT.into())
69 .expect("Error loading TypeScript parser");
70 }
71
72 #[test]
73 fn test_can_load_tsx_grammar() {
74 let mut parser = tree_sitter::Parser::new();
75 parser
76 .set_language(&super::LANGUAGE_TSX.into())
77 .expect("Error loading TSX parser");
78 }
79}