tree-sitter-bash

To begin developing or contributing to the tree-sitter-bash repository, you must first install the necessary dependencies using npm.

npm install

Use the following commands to build the project and execute the test suite. To maintain a continuous development workflow, you can also run tests in watch mode.

# Build and run tests once
npm run build
npm run test

# Run build and tests in watch mode
npm run test:watch

To lint files using the tree-sitter-bash grammar with ESLint, import eslint-config-treesitter and spread its configuration into your eslint.config.mjs (Flat Config) array. This provides the necessary rules and parser settings for tree-sitter based linting.

import treesitter from 'eslint-config-treesitter';

export default [
  ...treesitter,
];

The tree-sitter-bash package provides Node.js bindings for the Bash grammar. It is designed to be compatible with both standard Node.js environments (via node-gyp-build) and Bun (via prebuilt .node files).

When imported, the module exports the compiled tree-sitter grammar object. Additionally, it may export a nodeTypeInfo property containing metadata about node types from src/node-types.json if available.

const Bash = require('tree-sitter-bash');

// The exported object is the tree-sitter grammar
// You can use it with the main 'tree-sitter' library

The bindings export a nodeTypeInfo property which contains a mapping of node types defined in the Bash grammar. This is useful for programmatic inspection of the grammar's structure.

const Bash = require('tree-sitter-bash');

if (Bash.nodeTypeInfo) {
  console.log(Bash.nodeTypeInfo);
}