README.md

Awk major mode using tree-sitter

This package is compatible with and was tested against the tree-sitter grammar for Awk found at https://github.com/Beaglefoot/tree-sitter-awk.

It provides indentation, font-locking, imenu, and navigation support for Awk buffers.

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 Awk

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

(add-to-list
 'treesit-language-source-alist
 '(awk "https://github.com/Beaglefoot/tree-sitter-awk"))

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

Install awk-ts-mode.el from source

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

(require "[cloned nverno/awk-ts-mode]/awk-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 awk is unavailable (not-found): (libtree-sitter-awk libtree-sitter-awk.so) No such file or directory

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