Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/diku-dk/futhark-mode
Emacs major mode for editing Futhark programs
https://github.com/diku-dk/futhark-mode
emacs futhark
Last synced: 11 days ago
JSON representation
Emacs major mode for editing Futhark programs
- Host: GitHub
- URL: https://github.com/diku-dk/futhark-mode
- Owner: diku-dk
- License: isc
- Created: 2018-06-05T18:49:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T13:08:41.000Z (3 months ago)
- Last Synced: 2024-11-19T14:24:08.549Z (3 months ago)
- Topics: emacs, futhark
- Language: Emacs Lisp
- Size: 155 KB
- Stars: 9
- Watchers: 12
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# futhark-mode for Emacs
[](https://melpa.org/#/futhark-mode)[](https://github.com/diku-dk/futhark-mode/actions)
See the file `futhark-mode.el`. This Emacs mode provides:
* syntax highlighting
* automatic indentation
* interaction with an inferior `futhark repl` process
For IDE-like features, try [Eglot](https://github.com/joaotavora/eglot),
which works well with Futhark's built-in LSP server `futhark lsp`.
## Installation
You can install this mode with Emacs' package manager. Enable the
https://melpa.org/ archive, and install the `futhark-mode` package.
*Alternatively*, add the following lines to your Emacs init file:
(add-to-list 'load-path "path/to/futhark-mode")
(require 'futhark-mode)
## Usage
This mode is pretty straightforward and does not provide a lot of
bells and whistles. But it does have some commands:
* **C-c C-l** (`futhark-load-file`) loads the current file into
`futhark repl`, creating a new instance if a current one does not
exist.
You may also want to use the `futhark fmt` integration with commands
like `futhark-fmt-buffer`, or whenever you save with
`futhark-fmt-on-save-mode`. You can enable that automatically on load
as well:
```elisp
(add-hook 'futhark-mode-hook futhark-fmt-on-save-mode)
```
## Eglot
You can start Eglot automatically whenever you edit a Futhark file by
adding
```elisp
(add-hook 'futhark-mode-hook 'eglot-ensure)
```
to your init file.
## Testing (for developers)
Run `tools/test-indentation` to test if the auto-indentation works. If
you find a piece of code that futhark-mode cannot indent properly,
please fix it, and put a small example in the `tools/test-corpus`
directory to ensure that it doesn't break in the future.
Note that not all of the indentation examples in `tools/test-corpus` are
necessarily *ideal*. Some of them exemplify behaviour that we would
like to fix (but exist as a regression test to avoid even worse
outcomes).
Additionally, you can symlink the `tools/git-hooks/pre-commit` hook into
your local `.git/hooks` directory to automatically check your changes
before each commit.
## Authors
+ Niels G. W. Serup
+ Rasmus Wriedt Larsen
+ Troels Henriksen
## Reloading when hacking on the code
Add the directory containing the `.el` files to your load path with
(add-to-list 'load-path "/.../futhark-mode")
(require 'futhark-dev)
and then enter `M-x RET futhark-dev-reload RET` whenever needed.