Installation

tree-sitter requires Emacs 25.1 or above, built with dynamic module support. Some Emacs distributions have this disabled by default. To check whether your Emacs has dynamic module support enabled, try evaluating one of these:

(functionp 'module-load) ; should be t

module-file-suffix ; should be non-nil

Installing from an ELPA

• Add tree-sitter's ELPA to package-archives:

  (add-to-list 'package-archives '("ublt" . "https://elpa.ubolonton.org/packages/"))
  

• Run M-x package-refresh-contents.

• Install tree-sitter and tree-sitter-langs packages.

• Load the language bundle:

  (require 'tree-sitter-langs)
  

Installing with straight.el

• Install tree-sitter and tree-sitter-langs with custom recipes:

  (straight-use-package
   '(tree-sitter :host github
                 :repo "ubolonton/emacs-tree-sitter"
                 :files ("lisp/*.el")))
  
  (straight-use-package
   '(tree-sitter-langs :host github
                       :repo "ubolonton/emacs-tree-sitter"
                       :files ("langs/*.el" "langs/queries")))
  

• Load the language bundle:

  (require 'tree-sitter-langs)
  

Installing from Source

• Clone the source repository:

  git clone https://github.com/ubolonton/emacs-tree-sitter
  

• Add its lisp and langs directories to load-path:

  (add-to-list 'load-path "/path-to/emacs-tree-sitter/lisp")
  (add-to-list 'load-path "/path-to/emacs-tree-sitter/langs")
  

• Load the libraries in your config:

  (require 'tree-sitter)
  (require 'tree-sitter-hl)
  (require 'tree-sitter-langs)
  (require 'tree-sitter-debug)
  (require 'tree-sitter-query)