Skip to content

Commit cd9c679

Browse files
authored
Enhance README with Tree-sitter resources
Added links for Tree-sitter documentation and examples.
1 parent f50185d commit cd9c679

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ options:
8383

8484
## Defining Custom Metrics
8585

86-
GitEvo can be used to define custom code evolution metrics at the level of the concrete syntax tree (CST).
86+
GitEvo can be used to define custom code evolution metrics at the level of the concrete syntax tree (CST), thanks to [Tree-sitter](https://tree-sitter.github.io/tree-sitter).
8787
GitEvo provides three key classes that can be used in the scripts: `GitEvo`, `ParsedCommit`, and `ParsedFile`.
8888

8989
- `GitEvo` is the main class, the entry point to use the tool.
@@ -171,3 +171,15 @@ def decorated_functions(commit: ParsedCommit):
171171

172172
evo.run()
173173
```
174+
175+
#### More examples
176+
177+
See: https://github.com/andrehora/gitevo/tree/main/examples
178+
179+
#### More info about `tree_sitter.Node`
180+
181+
- `tree_sitter.Node` documentation: https://tree-sitter.github.io/py-tree-sitter/classes/tree_sitter.Node.html
182+
- Python node types: https://github.com/tree-sitter/tree-sitter-python/blob/master/src/node-types.json
183+
- JS node types: https://github.com/tree-sitter/tree-sitter-javascript/blob/master/src/node-types.json
184+
- TS node types: https://github.com/tree-sitter/tree-sitter-typescript/blob/master/typescript/src/node-types.json
185+
- Java node types: https://github.com/tree-sitter/tree-sitter-java/blob/master/src/node-types.json

0 commit comments

Comments
 (0)