/nushell-ts-mode

Emacs tree-sitter support for Nushell

Primary LanguageEmacs LispGNU General Public License v3.0GPL-3.0

Nushell Tree-Sitter mode

GNU Emacs MELPA License GPL 3 Build Status

A mode for Nushell that uses tree-sitter. (treesit introduced in Emacs 29)

example highlighting

As of 2023-09-08 nushell-ts-babel moved to separate repository.

Features

  • Syntax highlighting
  • Indentation
  • Completion
    • Using completion-at-point-functions
    • Using known keywords
    • Simple variable completion using tree-sitter variable query
  • Org babel integration
    • Highlighting
    • Execute source code blocks

Installation

Build tree-sitter-nu

  1. Run treesit-install-language-grammar
  2. Select "nu"
  3. Use URL https://github.com/nushell/tree-sitter-nu
  4. Pick "src"

Install package

You will need to clone the repo and load it manually or use whatever package manager you use.

(straight-use-package
 '(nushell-ts-mode :type git :host github :repo "herbertjones/nushell-ts-mode"))

For instance, on my system I have:

(use-package nushell-ts-mode
  :straight (nushell-ts-mode :type git :host github :repo "herbertjones/nushell-ts-mode")
  :config
  (require 'nushell-ts-babel)
  (defun hfj/nushell/mode-hook ()
    (corfu-mode 1)
    (highlight-parentheses-mode 1)
    (electric-pair-local-mode 1)
    (electric-indent-local-mode 1))
  (add-hook 'nushell-ts-mode-hook 'hfj/nushell/mode-hook))