mirror of https://github.com/Wilfred/difftastic/
Merge commit 'cc26b1ef111100f26a137bcbcd39fd4e35be9a59'
commit
beacd69dd2
@ -0,0 +1,42 @@
|
||||
# tree-sitter-ocaml
|
||||
|
||||
This crate provides Ocaml grammars for the [tree-sitter][] parsing library.
|
||||
There are separate grammars for implementation (`.ml`) and interface (`.mli`)
|
||||
files.
|
||||
|
||||
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`][tree-sitter crate] crate to use the parsed result in any useful
|
||||
way.)
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
tree-sitter = "0.20"
|
||||
tree-sitter-ocaml = "0.20"
|
||||
```
|
||||
|
||||
Typically, you will use the [language][language func] function to add this
|
||||
grammar to a tree-sitter [Parser][], and then use the parser to parse some code:
|
||||
|
||||
```rust
|
||||
let code = r#"
|
||||
module M = struct
|
||||
let x = 0
|
||||
end
|
||||
"#;
|
||||
let mut parser = Parser::new();
|
||||
parser
|
||||
.set_language(tree_sitter_ocaml::language_ocaml())
|
||||
.expect("Error loading OCaml grammar");
|
||||
let tree = parser.parse(code, None).unwrap();
|
||||
```
|
||||
|
||||
If you have any questions, please reach out to us in the [tree-sitter
|
||||
discussions] page.
|
||||
|
||||
[Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
|
||||
[language func]: https://docs.rs/tree-sitter-rust/*/tree_sitter_ocaml/fn.language_ocaml.html
|
||||
[Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
|
||||
[tree-sitter]: https://tree-sitter.github.io/
|
||||
[tree-sitter crate]: https://crates.io/crates/tree-sitter
|
||||
[tree-sitter discussions]: https://github.com/tree-sitter/tree-sitter/discussions
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue