1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 02:40:05 +08:00
SpaceVim/docs/layers/lang/lua.md

66 lines
1.9 KiB
Markdown
Raw Normal View History

2017-12-21 21:38:47 +08:00
---
title: "SpaceVim lang#lua layer"
description: "This layer is for lua development, provide autocompletion, syntax checking, code format for lua file."
---
2018-06-23 14:37:41 +08:00
# [Available Layers](../../) >> lang#lua
2017-12-21 21:38:47 +08:00
<!-- vim-markdown-toc GFM -->
2018-06-23 14:37:41 +08:00
- [Description](#description)
- [Install](#install)
- [Layer](#layer)
- [Syntax checking && Code formatting](#syntax-checking--code-formatting)
- [Key bindings](#key-bindings)
- [Inferior REPL process](#inferior-repl-process)
- [Running current script](#running-current-script)
2017-12-21 21:38:47 +08:00
<!-- vim-markdown-toc -->
## Description
This layer is for lua development.
2018-06-23 14:37:41 +08:00
## Install
2017-12-21 21:38:47 +08:00
### Layer
2018-06-23 14:37:41 +08:00
To use this configuration layer, update custom configuration file with:
```toml
[[layers]]
name = "lang#lua"
```
2017-12-21 21:38:47 +08:00
### Syntax checking && Code formatting
## Key bindings
### Inferior REPL process
2017-12-29 12:29:27 +08:00
Start a `lua` or `luap` inferior REPL process with `SPC l s i`. You may change the REPL command by layer option `repl_command`. For example, if you want to use `lua.repl`, load this layer via:
2017-12-21 21:38:47 +08:00
```vim
call SpaceVim#layers#load('lang#lua'
\ {
\ 'repl_command' : '~/.luarocks/lib/luarocks/rocks-5.3/luarepl/0.8-1/bin/rep.lua',
\ }
```
Send code to inferior process commands:
| Key Binding | Description |
| ----------- | ------------------------------------------------ |
| `SPC l b` | compile current lua buffer |
| `SPC l r` | run current lua file |
2017-12-29 12:28:17 +08:00
| `SPC l f` | format current lua file |
2017-12-21 21:38:47 +08:00
| `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 |
### Running current script
To running a ruby script, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.