NhanHo / tsi.el

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

tsi.el: tree-sitter indentation minor mode for Emacs

use the syntax tree provided by the tree-sitter minor mode as the basis for indentation.

tests?

Supported languages:

  • Javascript/Typescript/JSX/TSX
  • JSON
  • CSS/SCSS

Installation

  1. Dependencies: make sure you have tree-sitter installed already.
  2. Install: download this package and place tsi.el, and the desired language-specific tsi-<foo>.el files, inside a directory on your load-path. or install this repository via straight.el which does these things for you: (straight-use-package '(tsi :type git :host github :repo "orzechowskid/tsi.el"))
  3. Require: (require 'tsi-<foo>)
  4. Enable: (tsi-<foo>-mode t)

Configuration

Useful variables are members of the relevant language-specific custom group and can be viewed and modified with the command M-x customize-group [RET] tsi-<foo> [RET].

Bugs

If a supported language is not indenting in the way you feel it should, then maybe it's a bug! open an issue and we'll discuss it.

Contributing

PRs for existing and new languages are most welcome. Please make sure that any changes are accompanied with unit tests (see tsi-typescript.test.el for an example). Unit tests use the super rad buttercup framework, and can be run via the following shell command:

$ emacs -batch -q -L . -l tsi-<foo>.test

License

GPLv3. see LICENSE in the top level of this repository.

About

License:GNU General Public License v3.0


Languages

Language:Emacs Lisp 100.0%