All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Added option
call_parentheses: Specify whether to apply parentheses on function calls with single string or table arg. Possible options:Always(default),NoSingleString,NoSingleTable,None. (#329) - Added proper multiline hanging of generic for syntax. (#322)
- Fixed generic variadics not being handled under the
luaufeature flag. (#333)
- Option
no_call_parentheseshas been deprecated. Usecall_parentheses = "None"instead.
- Fixed comments preceding a comma within a function call or parameter list for a function definition being mistransformed leading to a syntax error. (#307)
- Fixed IfExpression having abnormal leading whitespace under the
luaufeature flag. (#315) - Fixed incorrect handling of comments in unusual places within a table causing mistransformations leading to syntax errors. (#318)
- Fixed spaces around brackets string (
[[string]]) used as an index or table key (i.e.[ [[string]] ]) being removed, leading to a syntax error. (#293) - Fixed incorrect shape calculation leading to arguments incorrectly expanding when under column width. (#298)
- Fixed incorrect shape calculation for singleline table at the column width boundary. (#296)
- Fixed IfExpression syntax containing extra/abnormal trailing whitespace when currently formatting as-is under the
luaufeature flag. (#297) - Fixed newlines before arguments in a function call which is later formatted on a single line being preserved, leading to inconsistent formatting. (#290)
- Fixed odd formatting when returning multiple tables or functions only. (#302)
- Fixed comments within an index expression (
foo[index]) incorrectly handled leading to malformed formatting. (#304)
- Updated internal parser to fix parsing issues and update
luauparsing. (#229, #231) - Default glob now matches
**/*.luau(as well as**/*.lua) when theluauflag is enabled. (#291)
- Fixed indentation of type callback specifier parameters when parameters have leading comment trivia. (#278)
- Fixed trailing comma not being taken into account when determining the width of a field in a multiline table. (#282)
- Fixed
--num-threads 1causing a deadlock. (#281) - Fixed whitespace around parts of a binary expression causing it to over-hang in first pass, leading to unstable formatting. (#287)
- In Luau type tables, a newline after the opening brace will now force the type table multiline. This is the same procedure as standard tables. (#226)
- In Luau, type specifiers for function parameters will now force the parameters to be formatted multiline if a specifier is multiline (and there is more than one parameter).
- Improved error messages to make them easier to understand.
- Fixed range formatting no longer working when setting the range to statements inside nested blocks. (#239)
- Fixed ignore file present in cwd not taken into account if cwd not included in file paths to format. (#249)
- Fixed config locations (
$XDG_CONFIG_HOMEand$HOME/.config) not being looked into correctly on macOS when--search-parent-directoriesis used. (#260) - Fixed incorrect indentation of multiline type specifiers for function parameters under the
luaufeature flag. (#256) - Fixed unstable formatting caused by a singleline table which just reaches the column width. (#261)
- Fixed misformatting of a binop expression as precedence of the RHS expression was not taken into account. (#257, #261)
- Fixed an incorrect trailing comma being added to function args as part of a multiline expression list leading to a syntax error. (#227)
- Fixed the first expression in a multiple assignment prematurely hanging even if its below the column width. (#233)
- Updated internal parser to fix parsing issues for Luau code under the
luaufeature flag.
- Added flag
--verifywhich, when enabled, attempts to verify the generated output AST with the input AST to detect any changes to code correctness. Useful for adopting StyLua into a large codebase, at the cost of slower processing. (#199) - Added optional command line options
--column-width,--indent-type,--indent-width,--line-endingsand--quote-style, which, when provided, will override any configuration setting inferred from the default or astylua.toml. (#213) - Added multithreaded support for formatting file in the CLI. Now each file will be formatted in its own thread. The number of threads used defaults to the number of cores on your computer, but can be set using
--num-threads - Added support for disabling formatting over specific ranges. Use
-- stylua: ignore startto disable formatting and-- stylua: ignore endto re-enable it. The comment must be preceding a statement and disabling formatting cannot cross block scope boundaries. (#198)
- Luau type tables (
luaufeature flag) now use the same formatting strategy as normal expression tables, so that their formatting is more aligned. - Luau typings now have improved checking against the current shape width to determine how to format if over column width.
- Luau callback types will now format multiline if they become over width under the
luaufeature flag. - Improved the formatting of return expressions, they are now more in line with assignment expressions. (#194)
- Changed buffering of error messages in the CLI. Originally, they would be buffered till the end, but now they are output immediately when seen.
- Allowed the use of
--checkwhen taking input from stdin. - An error when parsing provided globs will cause the program to immediately exit rather than continuing with the incorrect glob.
- Only diff errors will exit with a status code of
1. Other errors (e.g. parse errors or internal errors) will now exit with status code of2.
- Fixed comments inside Luau type tables leading to malformed formatting under the
luaufeature flag. (#219) - Fixed multiple assignment where an expression was originally hung due to comments being collapsed leading to malformed formatting. (#222)
- Fixed an issue where a function call with a single table argument being hugged with the parentheses which contain comments leading to a syntax error. (#224)
- Added
--verboseto print debug information, including finding config files and time taken to format files.
- Fixed severe performance regression due to a change in table formatting leading to exponential blowup for nested tables. (#205)
- Fixed long binop chains with a comment deep inside not being hung, leading to a syntax error. (#210)
- Bumped full-moon to
0.12.1to fix parsing bugs
- Fixed parentheses around type assertions being classed as unnecessary and removed under the
luaufeature flag. - Fixed mistransformation of function type where arguments have comments under the
luaufeature flag. (#201) - Fixed comments in an assignment in between the equals token and the expression leading to a mistransformation. (#200)
- Added
--stdin-filepathoption to specify location of file being taken in from stdin. This is optional and is only used to determine where to find the configuration file. If not provided, we default to searching from current working directory. (#192)
- Fixed empty functions with comments being incorrectly collapsed leading to syntax error. (#195)
- CLI will now look for
stylua.tomland its hidden counterpart,.stylua.toml. (#145) - Added CLI flag
--search-parent-directories. If enabled, we will look in parent directories for a configuration file, or look in$XDG_CONFIG_HOMEor$XDG_CONFIG_HOME/stylua. (#127, #146) - Updated full-moon: Added support for typed variadics, named function type args, and generic functions under the Luau feature flag
- Will now hang on equality operators within binary expressions, if over width.
- If a file path is explicitly provided to the CLI which doesn't end with
.luaending, the*.luaglob check is skipped. (#170) - Long type unions will now hang under the
luaufeature flag. (#165) - Added option
no_call_parentheses. Enabling this config will remove parentheses around function calls taking a single string/table as an argument. This config was added for adoption purposes. (#133)
- Long prefix expressions which are hangable and go over the line limit (e.g.
("foooo" .. "barrrrrrr" .. "bazzzzzz"):format(...)) will now hang multiline (#139) - Changed formatting for assignments. We will now try all tactics then determine the best one. Multiple assignments will now no longer attempt to hang a single expression first - we will hang the whole punctuated list. (#157)
- Function calls with single arguments are now possible to be expanded. This will allow the call to be expanded if the line goes over budget. (#156)
- StyLua will now firstly prefer hanging long arguments to function calls to try and fit under the width, before expanding them multiline. (#159)
- When hanging a binary expression, previously, we would always hang the "root" node of AST BinExp tree. Now we will check to see if is necessary (we are over width) before hanging (#163)
- StyLua will hug together table braces with function call parentheses when formatting a function call taking a single table as an argument. (#182)
- Function calls with more than one argument, where an argument is "complex", will now expand multiline. "complex" is an argument spanning multiple lines, but excludes a table or anonymous function, as we handle them explicitly. (#183)
- StyLua will always hang at the equals token for a multi-variable assignment. (#185)
- Tables with multiline fields (such as an anonymous function expression) should always expand if previously on single line. (#187)
- Function definitions (both normal and anonymous) with an empty body will now be kept on a single line. This is common for noop functions
local function noop() end. (#188)
- Fixed 1 or 2 digit numerical escapes being incorrectly removed
- Fixed whitespace being lost before a multiline comment. We will now preserve a single space (e.g.
local test --[[foo]] = true->local test --[[foo]] = true) (#136) - Fixed the double formatting of a hanging call chain when it was being assigned to a variable causing it to be incorrectly formatted (#151)
- Fixed leading comments to a binop in a hanging expression being lost (#154)
- Fixed mistransformation of comments leading the RHS of a hanging binop. They are now moved to before the binop (#154)
- Fixed comments trailing unnecessary parentheses around expressions that were later removed not being preserved (#176)
- Fixed a double unary minus (
- -foo/-(-foo)) being formatted as--fooleading to a comment syntax error. Parentheses are now enforced:-(-foo)(#171) - Fixed semicolon being removed leading to
function call x new statementambiguity when next statement is an assignment with the first variable being a parentheses var expression (#173) - Fixed mistransformation of comments in
if condition thenorwhile condition dolines - improved assurance that they will hang multiline (#164) - Fixed indentation of comments leading a
thenordotoken whenif ... thenorwhile ... doare multiline. - Fixed mistransformation of comments in a generic declaration under the
luaufeature flag (#166) - Fixed trailing comma being added after comments in multiline type table under the
luaufeature flag (#166)
- Fixed bug where a hanging expression inside of parentheses would lead to function arguments being incorrectly formatted with a trailing comma - leading to a syntax error
- Parentheses around conditions are now removed, as they are not required in Lua.
if (foo and (not bar or baz)) then ... endturns toif foo and (not bar or baz) then ... end - Long multi-variable assignments which surpass the column width, even when hanging on the equals token, will now hang on multiple lines.
- Changed the heursitics for when parentheses are removed around expressions. Parentheses will now never be removed around a function call prefix (e.g.
("hello"):len()) - Changed formatting for comma-separated lists. Previously, we would buffer the comments to the end of the list, but now we keep the comments next to where they original were.
- Improved contextual formatting informattion when formatting deep in the AST. We can now better determine how much space is left on the current line, before we need to change formatting
- Improved formatting of function declarations. It will now properly take into account the amount of space left on the column width.
- Improve formatting for assignments with expressions such as function calls. The whole assignment is now taken into account, so we can better determine whether to split the expression.
- Fixed trailing whitespace remaining on the last item of a multiline table (which was expanded from a singleline one)
- Fixed parentheses around a table being incorrectly removed leading to a syntax error, such as in
({}):foo()
- Added hanging for chained function calls. See #109
- Long function definitions (normally with parameters containing types and a return type) will now be split across multiple lines if they surpass the column limit
- Further improvements to the way binary expressions are hung on new lines
- Fixed trailing comments at the end of multiline tables being lost
- Fixed panic "stmt trailing comments not implemented" occuring due to incomplete function
- Fixed trailing comments after semicolons at the end of last statements being lost when formatting
- Fixed function parameters collapsing when there is a comments at the end of function parameters, where the last parameter has a type specifier
- Fixed comments at the end of tables being indented one extra level
- Fixed trailing comments within if-elseif-else blocks not being correctly indented.
- Fixed
doin awhile ... dostatement not correctly indented when the condition spans multiple lines - Fixed multiline parameters for a function definition inside of an indent block (e.g. a table) not being correctly indented
- Added support for creating new
Configstructs when using StyLua as a library - Added configuration for quote style. There are four quote style options -
AutoPreferDouble,AutoPreferSingle,ForceDoubleandForceSingle. For the auto styles, we will prefer the quote type specified, but fall back to the opposite if it means there are fewer escapes. For the force styles, we will always use the quote type specified. - StyLua will now error when unknown fields are found in the configuration
stylua.tomlfile - Long lines of assignments, where the expressions aren't hangable, will now be put onto a newline, where a newline is created after the equal sign, and the expressions indented.
- Added initial support for Lua 5.2 syntax. StyLua can now format code containing
gotos and labels. See #87 to track further support for Lua 5.2 syntax.
- Function call heuristic have been further improve to decide when to expand the function call arguments onto multiple lines.
- StyLua now allows some arguments after a multiline table before forcing expansion. This makes sense for something like
setmetatable({ ... }, class), where{ ... }is a multiline table, but we don't want to expand onto multiple lines. StyLua will not allow a mixture of multiline tables and small identifiers in between (e.g.call({ ... }, foo, { ... })), in order to improve readability. - Empty newlines at the start and end of a block will now be removed as they are unnecessary
- Changed the default quote style from
ForceDoubletoAutoPreferDouble. We will now default to swapping quote type if it will reduce the number of escapes.
- Fixed tables with internal comments (and no fields) incorrectly collapsing to a single line
- Fixed parentheses being incorrectly removed around a BinOp where first value was a UnOp
- Fixed indentation of leading comments bound to the end brace of a multiline table
- Fixed LastStmt (return/break etc.) still being formatted when it wasn't defined inside the range
- Fixed hanging expressions which are inside function calls being indented unnecessarily by one extra level
- Fixed parentheses being incorrectly removed around a function definition, which may be called like
(function() ... end)() - Fixed some string escapes being incorrectly deemed as unnecessary
- Fixed trailing comments after semicolons at the end of statements being lost when formatting
- Fixed formatting issues in relation to newline and whitespace when using range formatting.
- Fixed empty tables taking 2 formatting passes to format properly
- Added support for removing excess parentheses around expressions.
e.g.
print((x))will be formatted toprint(x), as the parentheses are unnecessary. We also consider cases where parentheses should not be removed, e.g.print((x()))- removing the parentheses changes the meaning of the code. - Added formatting of BinOp expressions within function calls. If there is a long expression as a function argument and it contains binops, it will now span multiple lines
- Added a
column_widthsetting, which is used to guide when StyLua should wrap lines. It defaults to120. - Added support for formatting ranges. You can now specificy ranges using
--range-start <num>and--range-end <num>(both optional, and both inclusive). If a range is provided, only statements within the range will be formatted. Currently only supports ranges containing whole statements, and is not more granular. - Added support for ignore comments. If the line before a statement begins with the comment
-- stylua: ignore, then the statement will be ignored during formatting. This currently only supports ignoring statement-level nodes
- Improved CLI
--checkoutput. We now use a more detailed output which should help in determining diffs - Improved calculations in places to determine when to wrap lines
- Fixed an expression ending with an UnOp (e.g.
#foo) and a trailing comment forcing an unnecessary hanging expression - Fixed loss of comments trailing punctuation within function parameters
- Comments within function parameters now force the parameter to go mutliline, fixing syntax errors created from previous formatting
- Fixed incorrect indentation of body of expressions spanning multiple lines (e.g. anonymous functions/tables) when the expression is part of a hanging binop
- Fixed incorrect formatting of multiple long comma-separated assignment/returns causing the comma to be placed onto a new line
- Fixed function calls being incorrectly expanded due to a comment within the arguments. We will now only check for leading/trailing comments for argument expressions to see if we need to keep it expanded or not.
- Added formatting for number literals which begin with a decimal. For consistency, a "0" will be prepended (i.e.
.5turns to0.5) - Long expressions in a return statement will now hang onto multiple lines if necessary
- StyLua will now handle expressions in parentheses if they are long, by breaking them down further.
- Added support for ambiguous syntax. StyLua will now keep the semicolon and format as required
- Fixed "then" and "do" tokens not being correctly indented when if-then and while-do statements are pushed onto multiple lines
- Fixed incorrect newline formatting when a return type is present for an anonymous function in Luau
- Fixed multiline expressions where the binop has a trailing comment being incorrectly formatted, breaking code
- Fixed a trailing comment at the end of a whole binop expression unnecessarily forcing a hanging expression
- StyLua will now test escapes of characters other than quotes in strings to see if they are unnecessary and remove them if so
- Adds wrapping for large expressions to push them onto multiple lines. Statements with line of longer than 120 characters will trigger expression wrapping where possible. The expression will be split at its Binary Operators, excluding relational operators.
- Fixed
.styluaignorefile extension matching not working due to the default override glob - Cleaned up descriptions of options when running
stylua --help - Fixed issue with
stylua.tomlrequiring a complete configuration file with all options set - Fixed issue with escapes unrelated to quotes inside of strings not being preserved
- Fixed incorrect formatting when trailing comments are present in function arguments and other locations. In function arguments, it will remain expanded if there is a comment present. Similarly, comments are now preserved in punctuated sequencues.
- Fixed
untiltoken in a repeat block not being correctly indented - Fixed regression causing the first and last item of an expanded table to not be correctly indented
- Changed heuristics for expanding function arguments. StyLua will now check through the arguments and look out for expanded tables or anonymous functions, and if found, will not expand the function call. However, if there are any other type of expression mixed between, then the function call will remain expanded.
- Change internals of the formatter by reducing amount of cloning of AST nodes. Improves performance by 22%
- StyLua will now take into account if a table was originally expanded onto multiple lines. If so, StyLua won't attempt to collapse it
- Added support for reading in from stdin for the CLI, use
stylua -to make StyLua read from stdin, and a formatted output will be written to stdout - Added
--checkcommand line flag. If enabled, then StyLua will check through the files and emit a diff for files with incorrect formatting, exiting with status code 1. StyLua will not modifiy files - Renamed CLI argument
--patternto--glob(with short form-g).--globcan now accept multiple globs. For example, usingstylua -g *.lua -g !*.spec.lua .will format all Lua files apart from.spec.luatest files. - Added support for parsing a
.styluaignorefile, which follows a similar structure to.gitignorefiles. Any patterns matched inside of this file will be ignored.
- Changed when a table will expand onto new lines. It will now expand after 80 characters have been exceeded, and takes indent level into account
- Changed the default value of
indent_widthto 4 - Function calls with a single argument will no longer wrap the argument onto a new line. This is subject to change.
- Fixed a new line being added after the
untiltoken in a repeat block. The new line is now added at the end of the until expression. - Fixed comments not being preserved within multiline tables
- Fixed trailing comma being added after comments in multiline tables
- Fixed escaping of double-quotes inside of strings being repeated
- Fixed long tables for types collapsing onto a single line for Luau formatting
- Fixed incorrect comment wrapping at the beginning of multiline tables
- Fixed start brace of multiline comments not having correct indentation
- Fixed comments having incorrect indentation when bound to the
endtoken at the end of a block.
- Single quote escapes are now removed from string literals if present when converting to double-quoted strings
- If there is a single argument in a function call, and it is either a table or anonymous function, the relevant start/end tokens are no longer pushed onto new lines
- Comments are now left completely unformatted, apart from trimming trailing whitespace at the end of single-line comments
- Double quotes are now escaped when converting from single quote to double quote strings
Initial alpha release