开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

An opinionated code formatter for Lua 5.1, Lua 5.2 and Luau, built using full-moon. StyLua is inspired by the likes of prettier, it parses your Lua codebase, and prints it back out from scratch, enforcing a consistent code style.

Installation

There are multiple ways to install StyLua:

With Github Releases

Pre-built binaries are available on the GitHub Releases Page.

By default, these are built with both Luau and Lua 5.2 features enabled, to cover all possible codebases. If you would like to format a specific Lua version only, see installing from crates.io.

From Crates.io

If you have Rust installed, you can install StyLua using cargo. By default, this builds for just Lua 5.1. You can pass the --features <flag> argument to build for Lua 5.2 (lua52) or Luau (luau)

cargo install stylua
cargo install stylua --features lua52
cargo install stylua --features luau

GitHub Actions

You can use the stylua-action GitHub Action in your CI to install and run StyLua. This action uses the prebuilt GitHub release binaries, instead of running cargo install, for faster CI times.

pre-commit

You can use StyLua with pre-commit. There are 3 possible pre-commit hooks available:

• stylua: installs via cargo - requires the Rust toolchain
• stylua-system: runs a stylua binary available on the PATH. The binary must be pre-installed
• stylua-github: automatically installs the relevant prebuilt binary from GitHub Actions

Add the following to your .pre-commit-config.yaml file:

- repo: https://github.com/JohnnyMorganz/StyLua
  rev: v0.14.2
  hooks:
    - id: stylua # or stylua-system / stylua-github

npm (wasm build)

StyLua is available as a wasm package, and is published to npm. It is usable in Node.js, or the in the browser (using a bundler).

Other Installation Methods

• VSCode Extension
• Aftman

aftman add johnnymorganz/[email protected]

• A community maintained package repository. Please note, these packages are maintained by third-parties and we do not control their packaging manifests.

Other Editor Integrations

Note that these integrations require the StyLua binary to already be installed and available on your system.

• Sublime: Sublime Text Package
• Neovim: stylua-nvim / stylua.nvim

Usage

Once installed, pass the files to format to the CLI:

stylua src/ foo.lua bar.lua

This command will format the foo.lua and bar.lua file, and search down the src directory to format any files within it. StyLua can also read from stdin, by using - as the file name.

Glob Filtering

By default, when searching through a directory, StyLua looks for all files matching the glob **/*.lua (or **/*.luau when luau is enabled) to format. You can also specify an explicit glob pattern to match against when searching:

stylua --glob '**/*.luau' -- src # format all files in src matching **/*.luau
stylua -g '*.lua' -g '!*.spec.lua' -- . # format all Lua files except test files ending with `.spec.lua`

Note, if you are using the glob argument, it can take in multiple strings, so -- is required to break between the glob pattern and the files to format.

Glob Filtering is only used for directory searching - passing a file directly (e.g. stylua foo.txt) will override the glob.

Filtering using .styluaignore

You can create a .styluaignore file, with a format similar to .gitignore. Any files matching the globs in the ignore file will be ignored by StyLua. For example, for a .styluaignore file with the following contents:

vendor/

running stylua . will ignore the vendor/ directory.

--check: Checking files for formatting

To check whether files have been formatted (but not write directly to them), use the --check flag. It will take files as input, and output a diff to stdout instead of rewriting the file contents. If there are files which haven't been fully formatted, StyLua will exit with status code 1.

By default, we provide a custom Standard diff view, but this can be configured:

• --output-format=unified: output a unified diff, which can be consumed by tools like patch or delta
• --output-format=json: output JSON representing the changes, useful for machine-readable output

--verify: Verifying formatting output

As a safety measure, the --verify flag can be passed to StyLua, and StyLua will verify the output of all formatting before saving it to a file.

If enabled, the tool will re-parse the formatted output to verify if the AST is still valid (no syntax errors) and is similar to the input (possible semantic changes).

Useful when adopting StyLua in a large codebase, where it is difficult to verify all formatting is correct. Note that this may produce false positives and negatives - we recommend manual verification as well as running tests to confirm.

Ignoring parts of a file

To skip formatting a particular part of a file, you can add -- stylua: ignore before it. This may be useful if there is a particular style you want to preseve for readability, e.g.:

-- stylua: ignore
local matrix = {
    { 0, 0, 0 },
    { 0, 0, 0 },
    { 0, 0, 0 },
}

Formatting can also be skipped over a block of code using -- stylua: ignore start and -- stylua: ignore end:

local foo = true
-- stylua: ignore start
local   bar   =   false
local  baz      = 0
-- stylua: ignore end
local foobar = false

Note that ignoring cannot cross scope boundaries - once a block is exited, formatting will be re-enabled.

Formatting Ranges

To format a specific range within a file, use --range-start <num> and/or --range-end <num>. Both arguments are inclusive and optional - if an argument is not provided, the start/end of the file will be used respectively.

Only whole statements lying within the range will be formatted. If part of a statement falls outside the range, the statement will be ignored.

In editors, Format Selection is supported.

Configuration

StyLua is opinionated, so only a few options are provided.

Finding the configuration

The CLI looks for stylua.toml or .stylua.toml in the directory where the tool was executed. If not found, the default configuration is used.

A custom path can be provided using --config-path <path>. If the path provided is not found/malformed, StyLua will exit with an error.

By default, the tool does not search further than the current directory. Recursively searching parent directories can be enabled using --search-parent-directories. This will keep searching ancestors. If not found, it will then look in $XDG_CONFIG_HOME / $XDG_CONFIG_HOME/stylua.

Note: enabling searching outside of the current directory is NOT recommended due to possibilities of conflicting formatting:

It is recommended to keep a .stylua.toml file in your project root so that other developers can make use of the same configuration.

If a project uses the default configuration of StyLua without a configuration file present, enabling external searching may cause conflicting formatting.

Options

StyLua only offers the following options:

Default stylua.toml, note you do not need to explicitly specify each option if you want to use the defaults:

column_width = 120
line_endings = "Unix"
indent_type = "Tabs"
indent_width = 4
quote_style = "AutoPreferDouble"
call_parentheses = "Always"