tree-sitter-typescript

Warnings

• breaking The `Language.build_library` method, previously used to compile grammars in older versions of `py-tree-sitter` (prior to approximately 0.22.x), has been removed. Grammars like `tree-sitter-typescript` are now expected to be installed as pre-compiled Python packages.
  Fix: Ensure you are using a recent version of `tree-sitter` (the core Python binding) and directly `pip install tree-sitter-typescript`. Do not attempt to use `Language.build_library`.
• breaking The underlying `tree-sitter` core library occasionally introduces Application Binary Interface (ABI) changes (e.g., ABI 15 in v0.25.0). These changes can cause compatibility issues with older `tree-sitter` Python bindings or grammar packages if they are not updated to match the new ABI.
  Fix: Always ensure your `tree-sitter` Python package and `tree-sitter-typescript` are kept up-to-date and compatible. If parsing issues arise after upgrading `tree-sitter`, update `tree-sitter-typescript` as well.
• gotcha While `tree-sitter-typescript` provides both TypeScript and TSX grammars, complex or less common syntax constructs (e.g., specific styled components patterns, LaTeX strings within templates, or certain advanced `import`/`export` declarations) may result in `ERROR` or `MISSING` nodes in the parsed syntax tree. This indicates the grammar could not fully parse that section.
  Fix: Monitor GitHub issues for known parsing limitations. If encountering `ERROR` nodes for valid syntax, consider reporting it as a bug to the `tree-sitter-typescript` GitHub repository.
• gotcha The `tree-sitter-typescript` grammar internally relies on the `tree-sitter-javascript` grammar for JavaScript-specific constructs. However, installing `tree-sitter-typescript` via pip does not automatically install `tree-sitter-javascript` as a separate Python package. This might lead to unexpected parsing behavior or errors if the JavaScript grammar is implicitly expected for certain parts of the code.
  Fix: If working with mixed JavaScript/TypeScript files or encountering issues that seem related to underlying JavaScript parsing, explicitly `pip install tree-sitter-javascript` alongside `tree-sitter-typescript`.

Install

• pip install tree-sitter tree-sitter-typescript Install with pip

Imports

• language

  from tree_sitter import Language, Parser
  import tree_sitter_typescript
  TS_LANGUAGE = Language(tree_sitter_typescript.language(), 'typescript')

  Used to load the standard TypeScript grammar.
• tsx_language

  from tree_sitter import Language, Parser
  import tree_sitter_typescript
  TSX_LANGUAGE = Language(tree_sitter_typescript.tsx_language(), 'tsx')

  Used to load the TSX (TypeScript React) grammar.

Quickstart

This quickstart demonstrates how to install `tree-sitter-typescript` and `tree-sitter`, then load both the TypeScript and TSX grammars to parse respective code snippets. It shows how to initialize a parser, set the language, parse code, and access the resulting syntax tree's root node.

from tree_sitter import Language, Parser
import tree_sitter_typescript

# Load the TypeScript grammar
TS_LANGUAGE = Language(tree_sitter_typescript.language(), 'typescript')

# Create a parser and set its language
parser = Parser()
parser.set_language(TS_LANGUAGE)

# Code to parse
ts_code = b"""interface MyInterface { name: string; age?: number; }\nconst x: MyInterface = { name: 'Alice' };"""

# Parse the code
tree = parser.parse(ts_code)

# Access the root node
root_node = tree.root_node
print(f"Parsed TypeScript root node type: {root_node.type}")

# Load the TSX grammar
TSX_LANGUAGE = Language(tree_sitter_typescript.tsx_language(), 'tsx')
parser.set_language(TSX_LANGUAGE)

# TSX code to parse
tsx_code = b"""function App() { return <div>Hello, {name}</div>; }"""

# Parse the TSX code
tree_tsx = parser.parse(tsx_code)
root_node_tsx = tree_tsx.root_node
print(f"Parsed TSX root node type: {root_node_tsx.type}")

# Example of finding a node
interface_node = root_node.children[0] # Assuming interface declaration is the first child
print(f"First node in TS: {interface_node.type}, text: {interface_node.text.decode('utf8')}")