Merge pull request #209 from emacs-tree-sitter/traversal

Improve tree traversal APIs

Author: ubolonton

.github/workflows/main.yml

@@ -89,3 +89,5 @@ jobs:
         run: npm install -g tree-sitter-cli@0.19.3
       - run: bin/test
         if: ${{ !matrix.target }}
+      - run: bin/test bench
+        if: ${{ !matrix.target }}

.github/workflows/release.yml

@@ -78,6 +78,8 @@ jobs:
         run: npm install -g tree-sitter-cli@0.19.3
       - run: bin/test
         if: ${{ !matrix.target }}
+      - run: bin/test bench
+        if: ${{ !matrix.target }}
 
       - name: Rename cross-build's binary
         if: matrix.target

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
+- Added APIs to traverse the syntax tree: `tsc-traverse-do`, `tsc-traverse-mapc`, `tsc-traverse-iter`. The traversal is depth-first pre-order.
+- Improved syntax tree rendering's performance in `tree-sitter-debug`.
+- Added optional params `props` and `output` to `tsc-current-node`, which allows retrieving node properties, instead of the node object itself. This enables performance optimizations in uses cases that deal with a large number of nodes.
 
 ## [0.17.0] - 2022-01-29
 - Added customization option `tsc-dyn-get-from`, which is a list of sources to get the dynamic module `tsc-dyn` from. Its default value is `(:github :compilation)`.

bin/test

@@ -14,6 +14,8 @@ if [[ $* == "watch" ]]; then
 else
     if [[ $* == "integ" ]]; then
         test_mod="tsc-dyn-get-tests.el"
+    elif [[ $* == "bench" ]]; then
+        test_mod="tree-sitter-bench.el"
     else
         test_mod="tree-sitter-tests.el"
     fi

bin/test.ps1

@@ -11,6 +11,8 @@ if ($args[0] -eq "watch") {
 } else {
     if ($args[0] -eq "integ") {
         $test_mod = "tsc-dyn-get-tests.el"
+    } elseif ($args[0] -eq "bench") {
+        $test_mod = "tree-sitter-bench.el"
     } else {
         $test_mod = "tree-sitter-tests.el"
     }