https://github.com/nverno/awk-ts-mode

Awk major-mode using tree-sitter
https://github.com/nverno/awk-ts-mode

awk emacs gawk tree-sitter

Last synced: 2 months ago
JSON representation

Awk major-mode using tree-sitter

• Host: GitHub
• URL: https://github.com/nverno/awk-ts-mode
• Owner: nverno
• License: gpl-3.0
• Created: 2023-09-28T01:46:31.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-17T12:52:02.000Z (9 months ago)
• Last Synced: 2024-05-17T14:04:35.578Z (9 months ago)
• Topics: awk, emacs, gawk, tree-sitter
• Language: Emacs Lisp
• Homepage:
• Size: 133 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Awk major mode using tree-sitter

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

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.

![example](doc/example.png)

## 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`. 

```elisp

(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

```elisp

(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.