Skip to content

Releases: JohnnyMorganz/StyLua

v0.6.0

27 Mar 15:36
Compare
Choose a tag to compare

[0.6.0] - 2021-03-27

Added

  • Added support for creating new Config structs when using StyLua as a library
  • Added configuration for quote style. There are four quote style options - AutoPreferDouble, AutoPreferSingle, ForceDouble and ForceSingle.
    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.toml file
  • 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.

Changed

  • 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 ForceDouble to AutoPreferDouble. We will now default to swapping quote type if it will reduce the number of escapes.

Fixed

  • 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

v0.5.0

24 Feb 17:41
Compare
Choose a tag to compare

[0.5.0] - 2021-02-24

Added

  • Added support for removing excess parentheses around expressions.
    e.g. print((x)) will be formatted to print(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_width setting, which is used to guide when StyLua should wrap lines. It defaults to 120.
  • 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

Changed

  • Improved CLI --check output. We now use a more detailed output which should help in determining diffs
  • Improved calculations in places to determine when to wrap lines

Fixed

  • 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

v0.4.1

05 Feb 21:52
Compare
Choose a tag to compare

[0.4.1] - 2021-02-05

Fixed

  • 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.

v0.4.0

05 Feb 19:19
Compare
Choose a tag to compare

[0.4.0] - 2021-02-05

Added

  • Added formatting for number literals which begin with a decimal. For consistency, a "0" will be prepended (i.e. .5 turns to 0.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

  • 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

v0.3.0

15 Jan 16:06
Compare
Choose a tag to compare

[0.3.0] - 2021-01-15

Added

  • 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

  • Fixed .styluaignore file extension matching not working due to the default override glob
  • Cleaned up descriptions of options when running stylua --help
  • Fixed issue with stylua.toml requiring 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.

v0.2.1

03 Jan 13:58
Compare
Choose a tag to compare

[0.2.1] - 2021-01-03

Fixed

  • Fixed until token 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

v0.2.0

31 Dec 15:01
Compare
Choose a tag to compare

[0.2.0] - 2020-12-31

Changed

  • 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%

v0.1.0

30 Dec 14:59
Compare
Choose a tag to compare

[0.1.0] - 2020-12-30

Added

  • 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 --check command 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 --pattern to --glob (with short form -g). --glob can now accept multiple globs.
    For example, using stylua -g *.lua -g !*.spec.lua . will format all Lua files apart from .spec.lua test files.
  • Added support for parsing a .styluaignore file, which follows a similar structure to .gitignore files. Any patterns matched inside of this file will be ignored.

Changed

  • 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

v0.1.0-alpha.3

26 Dec 21:17
Compare
Choose a tag to compare
v0.1.0-alpha.3 Pre-release
Pre-release

Changed

  • Changed the default value of indent_width to 4
  • Function calls with a single argument will no longer wrap the argument onto a new line. This is subject to change.

Fixed

  • Fixed a new line being added after the until token 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 end token at the end of a block.

v0.1.0-alpha.2

22 Dec 01:09
Compare
Choose a tag to compare
v0.1.0-alpha.2 Pre-release
Pre-release

Added

  • Single quote escapes are now removed from string literals if present when converting to double-quoted strings

Changed

  • 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

Fixed

  • Double quotes are now escaped when converting from single quote to double quote strings