summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMathias Jean Johansen <mathias@mjj.io>2021-07-09 16:54:43 +0200
committerGitHub <noreply@github.com>2021-07-09 23:54:43 +0900
commit1e9f40ff8d6a9d34fc84171e3cd416729b4506ec (patch)
tree1da3e605601c90bf2df06b1f77a4dfd3121c3cd5 /doc
parent8b73d98baf0a185886a55a62b8b32f6543f14af4 (diff)
downloadale-1e9f40ff8d6a9d34fc84171e3cd416729b4506ec.zip
Add support for `lua-format` fixer. (#3804)
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-lua.txt18
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 20 insertions, 0 deletions
diff --git a/doc/ale-lua.txt b/doc/ale-lua.txt
index db7c0924..ac92b9ac 100644
--- a/doc/ale-lua.txt
+++ b/doc/ale-lua.txt
@@ -2,6 +2,24 @@
ALE Lua Integration *ale-lua-options*
===============================================================================
+lua-format *ale-lua-lua-format*
+
+g:ale_lua_lua_format_executable *g:ale_lua_lua_format_executable*
+ *b:ale_lua_lua_format_executable*
+ Type: |String|
+ Default: `'lua-format'`
+
+ This variable can be changed to change the path to lua-format.
+
+g:ale_lua_lua_format_options *g:ale_lua_lua_format_options*
+ *b:ale_lua_lua_format_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to lua-format.
+
+
+===============================================================================
luac *ale-lua-luac*
g:ale_lua_luac_executable *g:ale_lua_luac_executable*
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 7f2b632c..639e1833 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -285,6 +285,7 @@ Notes:
* LLVM
* `llc`
* Lua
+ * `lua-format`
* `luac`
* `luacheck`
* `luafmt`
diff --git a/doc/ale.txt b/doc/ale.txt
index df64f06a..53dd2ea2 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2840,6 +2840,7 @@ documented in additional help files.
llvm....................................|ale-llvm-options|
llc...................................|ale-llvm-llc|
lua.....................................|ale-lua-options|
+ lua-format............................|ale-lua-lua-format|
luac..................................|ale-lua-luac|
luacheck..............................|ale-lua-luacheck|
luafmt................................|ale-lua-luafmt|