SpaceVim/docs/layers/lang/elm.md

title	description	image
SpaceVim lang#elm layer	This layer is for Elm development, provides autocompletion, syntax checking and code formatting for Elm files.	https://user-images.githubusercontent.com/13142418/44625046-7b2f7700-a931-11e8-807e-dba3f73c9e90.png

Available Layers >> lang#elm

• Description
• Features
• Install
  • Requirements
  • Layer
• Key bindings
  • Language specific key bindings
  • Inferior REPL process

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.

npm install -g elm

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

npm install -g elm-test

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

npm install -g elm-oracle

To automatically format your code, install elm-format.

npm install -g elm-format

Layer

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

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

Key bindings

Language specific key bindings

key bindings	Descriptions
SPC l d / K	Show doc of cursor symbol
SPC l m	Compile the current buffer
SPC l t	Runs the tests
SPC l e	Show error detail
SPC l w	Browse symbol doc

Inferior REPL process

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

Send code to inferior process commands:

key bindings	Descriptions
SPC l s b	send buffer and keep code buffer focused
SPC l s l	send line and keep code buffer focused
SPC l s s	send selection text and keep code buffer focused