Tree-sitter Ruby Grammar

tree-sitter-ruby provides a Ruby grammar for the tree-sitter incremental parsing library. It allows developers to generate concrete syntax trees (CSTs) for Ruby code, which can be used for syntax highlighting, code analysis, and refactoring tools.

For detailed information on the structure of the generated trees, refer to the AST Format of the Whitequark parser.

To apply the recommended ESLint rules for tree-sitter projects (including Ruby) to your JavaScript configuration, import eslint-config-treesitter and spread its exported configuration array into your eslint.config.mjs file.

import treesitter from 'eslint-config-treesitter';

export default [
  ...treesitter,
];

The tree-sitter-ruby package provides Node.js bindings for the Ruby grammar. It is designed to work with both standard Node.js (via node-gyp-build) and Bun (via prebuilt .node files). Once required, the module provides the necessary interface to parse Ruby code using the Tree-sitter engine.

Note: The module also exports nodeTypeInfo, which contains metadata about the different node types defined in the Ruby grammar, useful for inspecting the syntax tree.

const parser = require('tree-sitter-ruby');

// The exported object typically provides a parser instance or factory
// depending on how it is integrated with the core tree-sitter library.

The tree-sitter-ruby module exports a nodeTypeInfo property. This property contains a JSON object mapping node types to their specific characteristics in the Ruby grammar. This is useful for developers building tools that need to programmatically understand the structure of the Ruby syntax tree.

const ruby = require('tree-sitter-ruby');

if (ruby.nodeTypeInfo) {
  console.log('Available node types:', ruby.nodeTypeInfo);
}