SDML mode code-folding for Emacs

This package provides code-folding features for SDML - the Simple Domain Modeling Language buffers.

Installing

Install the ts-fold library (See https://github.com/emacs-tree-sitter/ts-fold) first which is a manual process unfortunately.

Install is easiest from MELPA, here's how with use-package. Note the hook clause to ensure this minor mode is always enabled for SDML source files.

(use-package ts-fold
  :load-path "path/to/install")

(use-package sdml-fold
  :after (ts-fold sdml-mode)
  :hook (sdml-mode . sdml-fold-mode)

Or, interactively; M-x package-install RET sdml-ispell RET

Usage

Block Folding is provided by the ts-fold-mode minor mode based on the configuration in the constant sdml-mode-tree-sitter-indent-scopes. Note that folding of groups of line comments is also supported.

• C-c C-s - -- fold item
• C-c C-s + -- unfold item
• C-c C-s C-- -- fold all items in buffer
• C-c C-s C-+ -- unfold all items in buffer
• C-c C-s / -- unfold item and all children
• C-c C-s . -- toggle fold/unfold state

As well as the mechanics of folding, the ts-fold package also has a fringe indicator support for windowed clients and this is enabled by default with window-system is non-nil.

To switch to left/right fringe (default is left-fringe):

(setq ts-fold-indicators-fringe 'right-fringe)

To lower/higher the fringe overlay's priority (default is 30):

(setq ts-fold-indicators-priority 30)

These options can be included in the use-package macro as shown below.

(use-package sdml-fold
  :after sdml-mode
  :custom
  (ts-fold-indicators-fringe 'right-fringe)
  (ts-fold-indicators-priority 30)
  :load-path "/path/to/repo")

Contributing

The packages in this repository should pass the standard package checks, including:

• byte-compile-file
• package-lint
• checkdoc

License

This package is released under the Apache License, Version 2.0. See the LICENSE file in this repository for details.

Changes

The 0.1.x series are all pre-release and do not appear in ELPA/MELPA.