A lua code formatter in Python !
Project description
A Lua code formatter written in Python.
Installation:
The package can be installed through pip:
$ python3.6 -m pip install luastyle
It will install the shell command ‘luastyle’.
Options
These are the command-line flags:
Usage: luastyle [options] filename
CLI Options:
--version Show program's version number and exit
-h, --help Show this help message and exit
-i, --in-place Write output in-place, replacing input
--config=F Path to config file
--config-generate Generate a default config file
--type=EXT File extension to indent (can be repeated) [lua]
-d, --debug Enable debugging messages
-j N, --jobs=N Number of parallel jobs in recursive mode
Beautifier Options:
-a, --space-around-assign Ensure one space before and after assign op "="
-c S, --indent-char=S Indentation character [" "]
-f, --check-field-list Format field-list (table)
-l N, --indent-level=N Initial indentation level [0]
-p, --check-param-list Format var-list, name-list and expr-list
-s N, --indent-size=N Indentation size [2]
-t, --indent-with-tabs Indent with tabs, overrides -s and -c
--close-on-lowest-level If several closing tokens, indent on lowest token level
-F N, --func-cont-level=N Continuation lines level in function arguments [2]
-I N, --if-cont-level=N If statement continuation line level [2]
-M, --check-line-comment-text Ensure that line comments text is started by at least N char
-N N, --com-txt-space-size=N If --check-line-comment-text is enabled, configure the number of spaces [1]
-S, --skip-sem-colon Skip all semi-colon after statements
--break-if Break mono-line if statement
--break-while In while and repeat statement, ensure newline after
"do" or "repeat" and before "end" or "until" keyword
--break-all Enable --break-if --break-for and --break-while and
before "end" or "until" keyword
--force-call-spaces Force spaces before opening parenthesis in function
call [0]
--call-spaces-size=N If --force-call-spaces is enabled, configure the
number of spaces
--strict Enable all features
Loading settings from environment or .luastylerc
In addition to CLI arguments, you may pass a config file via:
the LUASTYLE_CONF environment variables pointing to a config file
a .luastylerc file located in your user directory
Options examples
Continuation lines level in function arguments (-F)
-F N, --func-cont-level=N Continuation lines level in function arguments [2]
Given:
local function process(param_1, param_2, param_3,
param_4, param_5, param_6)
return do_something()
end
$ luastyle -c "." -F 2 source.lua
local function process(param_1, param_2, param_3,
....param_4, param_5, param_6)
..return do_something()
end
Break If statement option (–break-if)
Given:
if condition then return success() else return failure() end
$ luastyle --break-if source.lua
if condition then
return success()
else
return failure()
end
Format table field-list (-f)
- This option ensure that:
field separator in table (‘,’ or ‘;’) are trailing
comma is preceded by one space and followed by two spaces
The keyword ‘@luastyle.disable’ placed in a comment just after the opening brace will disable this feature in the concerned table.
Given:
local days = {
monday = 1,
tuesday = 2
, wednesday = 3
}
local n = {1 , 2,3}
local t = {
-- @luastyle.disable
1, 2, 4,
8, 16, 32
}
$ luastyle -f source.lua
local days = {
monday = 1,
tuesday = 2,
wednesday = 3
}
local n = {1, 2, 3}
local t = {
-- @luastyle.disable
1, 2, 4,
8, 16, 32
}
Indent closing token (–close-on-lowest-level )
Given:
describe('must indent', function()
done()
end)
$ luastyle --close-on-lowest-level source.lua
describe('must indent', function()
done()
end)
$ luastyle source.lua
describe('must indent', function()
done()
end)
Function call formatting options (–force-call-spaces, –call-spaces-size)
Given:
build (foo)
$ luastyle --force-call-spaces source.lua
build(foo)
$ luastyle --force-call-spaces --call-spaces-size=1 source.lua
build (foo)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Comments formatting options (-M, -N)
Available options are:
Given: