Adapter for StyLua for use as a formatting plugin in dprint. It formats Lua and Luau files (.lua and .luau), including Lua 5.1 through 5.4, LuaJIT, and CfxLua.

Install and setup dprint.

Then in your project's directory with a dprint.json file, run:

dprint add stylua

Note: You do not need StyLua installed globally as dprint will run StyLua from the .wasm file in a sandboxed environment.

To add configuration, specify a "stylua" key in your dprint.json:

{
  "stylua": {
    "syntax": "luau",
    "lineWidth": 120,
    "useTabs": false,
    "indentWidth": 2,
    "quoteStyle": "autoPreferSingle",
    "callParentheses": "noSingleTable",
    "collapseSimpleStatement": "functionOnly",
    "sortRequires": true,
  },
  "plugins": [
    // ...etc...
  ],
}

The options and their defaults match StyLua's, with dprint's names for the common ones:

Option values are camelCase versions of StyLua's (ex. "AutoPreferSingle" is "autoPreferSingle" and "LuaJIT" is "luajit"). Since the defaults are StyLua's, the global lineWidth, useTabs, indentWidth and newLineKind in your dprint.json are used when they're set and StyLua's defaults otherwise.

The plugin doesn't read stylua.toml, .stylua.toml or .editorconfig files, so move that configuration into dprint.json. -- stylua: ignore comments work as they do with StyLua, and range formatting is supported.

For an overview of the config, see https://github.com/dprint/dprint-plugin-stylua/blob/main/deployment/schema.json

• JS Formatter - Browser/Deno and Node
• npm package

This repo automatically upgrades to the latest version of StyLua once a day. You can check which version of StyLua is being used by looking at the stylua entry in the Cargo.toml file in this repo:

https://github.com/dprint/dprint-plugin-stylua/blob/main/Cargo.toml

At the moment, the version of this plugin does not reflect the version of StyLua.

This project is licensed under the MIT License - see the LICENSE file for details. StyLua is licensed under the Mozilla Public License 2.0.