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

Emacs major-mode for Jack (Nand2Tetris) language
https://github.com/nverno/jack-ts-mode

emacs jack nand2tetris tree-sitter

Last synced: 13 days ago
JSON representation

Emacs major-mode for Jack (Nand2Tetris) language

• Host: GitHub
• URL: https://github.com/nverno/jack-ts-mode
• Owner: nverno
• License: gpl-3.0
• Created: 2023-11-10T13:13:23.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-10T16:15:42.000Z (about 1 year ago)
• Last Synced: 2024-11-17T05:17:08.228Z (2 months ago)
• Topics: emacs, jack, nand2tetris, tree-sitter
• Language: Emacs Lisp
• Homepage:
• Size: 203 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## jack-ts-mode - Emacs major mode for Jack language from nand2tetris

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

A major mode for editing Jack programming language files. 

The Jack language  is developed as part of the

[Nand2Tetris]([nand2tetris.org](https://www.nand2tetris.org/)) coures (available

on Coursera [Nand to Tetris Part II](https://www.coursera.org/learn/nand2tetris2)).

This mode provides the following features for Jack source buffers:

  - font-locking

  - indentation

  - structural navigation with tree-sitter objects

  - imenu

  

![example](doc/jack.png)

For a major-mode without tree-sitter, see

[jack-mode](https://github.com/nverno/jack-mode).

## Installation

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 Jack

```elisp

(add-to-list

 'treesit-language-source-alist

 '(jack "https://github.com/nverno/tree-sitter-jack"))

(treesit-install-language-grammar 'jack)

```

### Install jack-ts-mode.el from source

- Clone this repository

- Add the following to your emacs config

```elisp

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

```