textbringer-tree-sitter

Tree-sitter based syntax highlighting plugin for Textbringer.

• Accurate syntax parsing with Tree-sitter
• Properly highlights Terraform/HCL for, in, and function calls (which Rouge fails to recognize)
• Emacs-style feature-based level control
• Customizable node mappings

gem 'textbringer-tree-sitter'

The following parsers are automatically installed during gem install:

• ruby
• python
• javascript
• json
• bash

These are downloaded from Faveod/tree-sitter-parsers and placed in ~/.textbringer/parsers/{platform}/.

Use the CLI tool to install additional parsers:

# List available parsers and their installation status
textbringer-tree-sitter list

# Install a specific parser (downloads prebuilt or builds from source)
# Also generates a node_map if one doesn't exist in the gem
textbringer-tree-sitter get hcl
textbringer-tree-sitter get markdown

# Install parser only, skip node_map generation
textbringer-tree-sitter get markdown --no-map

# Install all Faveod prebuilt parsers at once
textbringer-tree-sitter get-all

Parsers are stored in ~/.textbringer/parsers/{platform}/.

# Show parser directory
textbringer-tree-sitter path

Once a parser is installed and a node_map exists for the language, syntax highlighting is automatically enabled for the corresponding Mode (e.g., RubyMode, PythonMode, HCLMode).

The get command:

1. Downloads or builds the parser
2. Automatically generates a node_map if one doesn't exist in the gem
3. Places the node_map in ~/.textbringer/tree_sitter/node_maps/

For custom Modes, call use_tree_sitter:

class MyMode < ProgrammingMode
  extend Textbringer::TreeSitterAdapter::ClassMethods
  use_tree_sitter :ruby
end

# ~/.textbringer.rb

# Level 1: comment, string only
# Level 2: + keyword, type, constant
# Level 3: + function_name, variable, number (default)
# Level 4: + operator, punctuation, builtin

CONFIG[:tree_sitter_highlight_level] = 4

CONFIG[:tree_sitter_enabled_features] = [:comment, :string, :keyword]

Textbringer::TreeSitter::NodeMaps.register(:ruby, {
  my_custom_node: :keyword
})

CONFIG[:tree_sitter_parser_dir] = "/path/to/your/parsers"

These parsers are available from Faveod and include node_maps in the gem:

These parsers require building from source but include node_maps:

These parsers require building from source and node_map generation:

To regenerate a node_map manually:

textbringer-tree-sitter generate-map <language>

WTFPL - See LICENSE.txt for details.

THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.