stylua

Opinionated Lua code formatter

TLDR

Format file

$ stylua [script.lua]

Format multiple files

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

Format directory

$ stylua [src/]

Check formatting (don't modify)

$ stylua --check [script.lua]

Show diff (don't modify)

$ stylua --diff [script.lua]

Format from stdin

$ cat [script.lua] | stylua -

Use specific config

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

SYNOPSIS

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. If no config file is found, StyLua also checks for an .editorconfig file.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 via the --syntax flag or syntax option in the config file.Integration with editors enables format-on-save. CI integration ensures consistent style across contributions. A .styluaignore file (with .gitignore-like syntax) can be used to exclude files from formatting.

PARAMETERS

--check

Check without formatting.

--diff

Show diff without formatting.

--config FILE

Configuration file.

--search-parent-directories

Search for config in parents.

--stdin-filepath PATH

Path for stdin input.

--column-width N

Line width.

--indent-type TYPE

Tabs or spaces.

--indent-width N

Indent width.

--line-endings TYPE

Unix or windows.

--quote-style STYLE

String quote style.

--call-parentheses STYLE

Call parentheses style.

-g, --glob PATTERN

Glob pattern for filtering files. Use -- to separate glob patterns from file arguments.

--verify

Verify output by re-parsing formatted code to ensure no syntax errors were introduced.

--syntax SYNTAX

Lua syntax version: All (default), Lua51, Lua52, Lua53, Lua54, LuaJIT, Luau, CfxLua.

--respect-ignores

Respect .styluaignore rules even for files passed directly on the command line.

-v, --verbose

Verbose output.

CONFIGURATION

stylua.toml or .stylua.toml

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

.styluaignore

Ignore file with .gitignore-like syntax for excluding files from formatting.

INSTALL

sudo pacman -S stylua

sudo apk add stylua

brew install stylua

nix profile install nixpkgs#stylua

CAVEATS

Some style preferences can't be configured. Complex expressions may format unexpectedly. Column width is a guide for line wrapping, not a hard limit.

HISTORY

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