nverno / sql-ts-mode

SQL major mode using tree-sitter

This package provides a SQL major mode powered by tree-sitter.

The compatible tree-sitter grammar for SQL found can be installed from tree-sitter-sql.

This mode provides indentation and font-locking for SQL buffers.

TODO:

• imenu
• navigation

Installing

Emacs 29.1 or above with tree-sitter support is required.

Tree-sitter starter guide: https://git.savannah.gnu.org/cgit/emacs.git/tree/admin/notes/tree-sitter/starter-guide?h=emacs-29

Install tree-sitter parser for SQL

Add the source to treesit-language-source-alist.

(add-to-list
 'treesit-language-source-alist
 '(sql "https://github.com/DerekStride/tree-sitter-sql" "gh-pages"))

Then run M-x treesit-install-language-grammar and select sql to install.

Install sql-ts-mode.el from source

• Clone this repository
• Add the following to your emacs config

(require "[cloned nverno/sql-ts-mode]/sql-ts-mode.el")

Troubleshooting

If you get the following warning:

⛔ Warning (treesit): Cannot activate tree-sitter, because tree-sitter
library is not compiled with Emacs [2 times]

Then you do not have tree-sitter support for your emacs installation.

If you get the following warnings:

⛔ Warning (treesit): Cannot activate tree-sitter, because language grammar for sql is unavailable (not-found): (libtree-sitter-sql libtree-sitter-sql.so) No such file or directory

then the sql grammar files are not properly installed on your system.