7 releases (3 stable)

1.1.0 Feb 1, 2024
1.0.1 Jun 18, 2023
1.0.0 May 13, 2023
0.0.4 Apr 15, 2023
0.0.3 Mar 24, 2023

#187 in Text editors

MIT license

23K SLoC

C 23K SLoC JavaScript 277 SLoC // 0.1% comments Scheme 94 SLoC // 0.1% comments Rust 31 SLoC // 0.1% comments


This crate provides a Luadoc grammar for the tree-sitter parsing library. To use this crate, add it to the [dependencies] section of your Cargo.toml file. (Note that you will probably also need to depend on the tree-sitter crate to use the parsed result in any useful way.)

tree-sitter = "~0.20.9"
tree-sitter-luadoc = "1.1.0"

Typically, you will use the language function to add this grammar to a tree-sitter Parser, and then use the parser to parse some code:

let code = r#"
@type Car|Ship|fun(type: string, data: any):void|table<string, string[]>|"one"|"two"
let mut parser = Parser::new();
parser.set_language(tree_sitter_luadoc::language()).expect("Error loading Luadoc grammar");
let parsed = parser.parse(code, None);

If you have any questions, please reach out to us in the tree-sitter discussions page.


~71K SLoC