tree-sitter-apache-avro 0.1.1

Unofficial Apache Avro Language Parser for the IDL Language
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

# Tree Sitter Apache Avro

## Introduction

This is an **unofficial** Apache Avro IDL (.avdl) based on the
official specs:

- [avdl](https://avro.apache.org/docs/1.11.1/idl-language/)

If you notice any bug or problem, please submit an issue or make a pull request.
Any contribution is welcomed and needed.

## Development

**Requirements:**

- Rust >= 1.90
- Node.js >= 24
- [Tree Sitter CLI](https://tree-sitter.github.io/tree-sitter/creating-parsers/1-getting-started.html)
- Docker (For the playground)

All the parsing logic is specified in `grammar.js` at the root level. To see if
the changes made to it are working, run the tests and compare the results.

```sh
npm test:parser
```

A playground is also available to test the parser (though it needs Docker to
run)

```sh
npm start
```

More information about how to write or use the tree parser can be found here:
[http://tree-sitter.github.io/tree-sitter/](http://tree-sitter.github.io/tree-sitter/)

To test the bindings you can also do the following

```sh
tree-sitter parse ./test/protocol.avdl
tree-sitter parse ./test/schema.avdl
```

To check for highlights, run the following

```sh
tree-sitter highlight --check ./test/schema.avdl
tree-sitter highlight --check ./test/protocol.avdl
```

Just make sure to include the local directory where you have this parser in the
local tree-sitter configuration. For example, if I have this path under
`Documents/Code/tree-sitter-apache-avro`  then the config should be

```json
{
  "parser-directories": [
    "/Users/my_user/github",
    "/Users/my_user/src",
    "/Users/my_user/source",
    "/Users/my_user/projects",
    "/Users/my_user/dev",
    "/Users/my_user/git",
    "/Users/my_user/Documents/Code"
  ],
}
```