spacemacs/layers/+lang/lua/README.org
Boris a18998ccfd update lua readme
Add a note about luacheck
2016-02-25 20:32:12 +01:00

38 lines
1.3 KiB
Org Mode

#+TITLE: Lua contribution layer for Spacemacs
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="../../../css/readtheorg.css" />
[[file:img/lua.gif]]
* Table of Contents :TOC_4_org:noexport:
- [[Description][Description]]
- [[Features:][Features:]]
- [[Install][Install]]
- [[Key Bindings][Key Bindings]]
- [[Commands][Commands]]
* Description
This layer adds support for editing Lua.
** Features:
- Editing lua files using [[https://github.com/immerrr/lua-mode][lua-mode]]
- Sending code to a lua REPL
- Code linting using [[https://github.com/mpeterv/luacheck][Luacheck]]
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =lua= to the existing =dotspacemacs-configuration-layers= list in this
file.
In order to enable code linting, install [[https://github.com/mpeterv/luacheck][Luacheck]].
* Key Bindings
** Commands
| Key Binding | Description |
|-------------+--------------------------------------------|
| ~SPC m d~ | lookup thing at point in lua documentation |
| ~SPC m s b~ | send buffer contents to REPL |
| ~SPC m s f~ | send current function to REPL |
| ~SPC m s l~ | send current line to REPL |
| ~SPC m s r~ | send current region to REPL |