stylua

Format file

$ stylua [script.lua]

$ stylua [file1.lua] [file2.lua]

$ stylua [src/]

$ stylua --check [script.lua]

$ stylua --diff [script.lua]

$ cat [script.lua] | stylua -

$ stylua --config [stylua.toml] [script.lua]

stylua [--check] [--diff] [--config file] [options] [files]

stylua formats Lua code according to configurable style rules. It enforces consistent formatting automatically.
Configuration in stylua.toml or .stylua.toml sets project preferences. Options include indentation, line width, quote style, and more.
Check mode verifies formatting without changes. It returns non-zero exit code if files would be reformatted, suitable for CI.
Diff mode shows what would change. This helps review formatting before applying it.
The formatter handles various Lua versions and can be configured for game-specific variants like Roblox Luau.
Integration with editors enables format-on-save. CI integration ensures consistent style across contributions.

--check

Check without formatting.

Show diff without formatting.

Configuration file.

Search for config in parents.

Path for stdin input.

Line width.

Tabs or spaces.

Indent width.

Unix or windows.

String quote style.

Call parentheses style.

Glob pattern.

Verbose output.

stylua.toml or .stylua.toml

Project configuration file specifying formatting rules such as column width, indent type, quote style, and call parentheses behavior.

Some style preferences can't be configured. Complex expressions may format unexpectedly. Very long lines may not wrap perfectly.

StyLua was created by JohnnyMorganz around 2020. Written in Rust, it provides fast, opinionated Lua formatting similar to Prettier for JavaScript.

lua(1), luacheck(1), selene(1)