This mode uses tree-sitter (and Emacs 29's treesit
package) under-the-hood for syntax highlighting and code navigation. If you're using an Emacs that's older than 29 (run M-x version
to find out), or a version compiled without treesit
(run M-: (treesit-available-p)
to find out), you probably want gleam-mode instead.
https://user-images.githubusercontent.com/2058614/151681785-5d212e1b-191b-4e7d-a868-f6e42d7efe61.mp4
This project will eventually be hosted on MELPA. However, until that time, the best way to install this is first to clone the project:
$ git clone git@github.com:gleam-lang/gleam-mode
Then you'll need to load this from your init script (~/.emacs
or ~/.config/emacs/init.el
).
(use-package gleam-ts-mode
:load-path "~/path/to/gleam-mode")
Replace ~/path/to/gleam-mode
with the path where you cloned gleam-mode.
(add-to-list 'load-path "~/path/to/gleam-mode")
(load-library "gleam-ts-mode")
Replace ~/path/to/gleam-mode
with the path where you cloned gleam-mode.
Unless you have the Gleam tree-sitter grammar installed and treesit knows where to find it, you'll want to run M-x gleam-ts-install-grammar
. It should only take a moment, but does require that your OS has a C compiler available.
This mode uses tree-sitter alongside tree-sitter-mode and tree-sitter-indent for syntax highlighting and code navigation.
https://user-images.githubusercontent.com/2058614/151681785-5d212e1b-191b-4e7d-a868-f6e42d7efe61.mp4
The best way to install this is first to clone the project:
$ git clone --recurse-submodules git@github.com:gleam-lang/gleam-mode
Then you'll need to load this from your init script (~/.emacs
or ~/.config/emacs/init.el
).
(use-package gleam-mode
:load-path "~/path/to/gleam-mode")
Replace ~/path/to/gleam-mode
with the path where you cloned gleam-mode.
(add-to-list 'load-path "~/path/to/gleam-mode")
(load-library "gleam-mode")
Replace ~/path/to/gleam-mode
with the path where you cloned gleam-mode.
gleam-mode ships with a gleam-format
command that is not bound by default to any keybinding. To bind it:
Add :bind (:map gleam-mode-map (<binding> . gleam-format))
to your use-package declaration. e.g.
(use-package gleam-mode
:load-path "~/path/to/gleam-mode"
:bind (:map gleam-mode-map
("C-c g f" . gleam-format)))
(here "C-c g f" means Control
+C
followed by g
followed by f
)
Add the following after the lines where you setup gleam-mode:
(define-key gleam-mode-map (kbd "C-c g f") 'gleam-format)
(here "C-c g f" means Control
+C
followed by g
followed by f
)
Alternatively, add these lines to your configuration to automatically run gleam-format
on save:
(add-hook 'gleam-mode-hook
(lambda () (add-hook 'before-save-hook 'gleam-format nil t)))
This program is licensed under The Apache License, Version 2.0 or, at your option, under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. See LICENSE-apache for the terms of the Apache License, Version 2.0 or LICENSE-gpl for the terms of the GNU Public License, Version 3.