Back to Spacevim

SpaceVim lang#elm layer

docs/layers/lang/elm.md

2.4.02.3 KB
Original Source

Available Layers >> lang#elm

<!-- vim-markdown-toc GFM --> <!-- vim-markdown-toc -->

Description

This layer is for Elm development.

Features

  • Code completion
  • Syntax highlighting
  • Indentation
  • Running unite test
  • Syntax checking
  • Find symbol doc

SpaceVim also provides REPL support for Elm.

Install

Requirements

First, make sure you have the Elm Platform installed. The simplest method to get started is to use the official npm package.

sh
npm install -g elm

In order to run unit tests from within vim, install elm-test

sh
npm install -g elm-test

For code completion and doc lookups, install elm-oracle.

sh
npm install -g elm-oracle

To automatically format your code, install elm-format.

sh
npm install -g elm-format

Layer

To use this configuration layer, update your custom configuration file with:

toml
[[layers]]
  name = "lang#elm"

Key bindings

Language specific key bindings

key bindingsDescriptions
SPC l d / KShow doc of cursor symbol
SPC l mCompile the current buffer
SPC l tRuns the tests
SPC l eShow error detail
SPC l wBrowse symbol doc

Inferior REPL process

Start a elm repl inferior REPL process with SPC l s i.

Send code to inferior process commands:

key bindingsDescriptions
SPC l s bsend buffer and keep code buffer focused
SPC l s lsend line and keep code buffer focused
SPC l s ssend selection text and keep code buffer focused