1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 22:30:04 +08:00
SpaceVim/docs/layers/lang/elixir.md

73 lines
2.2 KiB
Markdown
Raw Normal View History

2017-12-17 14:11:57 +08:00
---
title: "SpaceVim lang#elixir layer"
2021-06-21 20:39:29 +08:00
description: "This layer is for Elixir development, provides autocompletion, syntax checking, code formatting for Elixir files."
2017-12-17 14:11:57 +08:00
---
2018-06-23 14:37:41 +08:00
# [Available Layers](../../) >> lang#elixir
2017-12-17 14:11:57 +08:00
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Features](#features)
- [Install](#install)
- [Layer](#layer)
- [Key bindings](#key-bindings)
- [Language specific key bindings](#language-specific-key-bindings)
2017-12-17 14:11:57 +08:00
- [Inferior REPL process](#inferior-repl-process)
- [Running current script](#running-current-script)
<!-- vim-markdown-toc -->
## Description
This layer is for Elixir development.
## Features
2021-06-21 20:39:29 +08:00
This layer includes the plugin [slashmili/alchemist.vim](https://github.com/slashmili/alchemist.vim), which provides:
2017-12-17 14:11:57 +08:00
- Completion for Modules and functions.
- Documentation lookup for Modules and functions.
- Jump to the definition.
2019-02-03 20:51:01 +08:00
SpaceVim also provides REPL, code runner and Language Server protocol support for Elixir. To enable language server protocol
for Elixir, you need to load `lsp` layer for Elixir.
2017-12-17 14:11:57 +08:00
## Install
### Layer
2021-06-21 20:39:29 +08:00
To use this configuration layer, update your custom configuration file with:
2018-06-23 14:37:41 +08:00
```toml
[[layers]]
name = "lang#elixir"
```
2017-12-17 14:11:57 +08:00
## Key bindings
### Language specific key bindings
2019-02-03 20:51:01 +08:00
| Key Bindings | Descriptions |
| --------------- | -------------------------------- |
| `SPC l d` / `K` | Show doc of cursor symbol |
| `SPC l t` | Jump to tag stack |
| `SPC l e` | Rename symbol (need `lsp` layer) |
| `g d` | Jump to definition |
2017-12-17 14:11:57 +08:00
### Inferior REPL process
2019-01-07 21:15:22 +08:00
Start a `iex` inferior REPL process with `SPC l s i`.
2017-12-17 14:11:57 +08:00
Send code to inferior process commands:
2019-02-03 20:51:01 +08:00
| 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 |
2017-12-17 14:11:57 +08:00
### Running current script
2021-06-21 20:39:29 +08:00
To run the current script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.