Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ Note that these integrations require the StyLua binary to already be installed a

- Sublime: [Sublime Text Package](https://github.com/aerobounce/Sublime-Pretty-Lua)
- Neovim: [stylua-nvim](https://github.com/ckipp01/stylua-nvim) / [stylua.nvim](https://github.com/wesleimp/stylua.nvim)
- Zed: [Zed Lua StyLua formatter settings](https://zed.dev/docs/languages/lua#stylua)

## Usage

Expand Down Expand Up @@ -154,6 +155,15 @@ vendor/

running `stylua .` will ignore the `vendor/` directory.

### Filtering when using stdin

If you are formatting stdin by specifying `-` as the filename (usually as part of an editor integration)
you can optionally provide the filename via `--stdin-filepath`. To respect glob or `.styluaignore` filtering, pass `--respect-ignores`.

```stylua
stylua --respect-ignores --stdin-filepath src/foo.lua -
```

### `--check`: Checking files for formatting

To check whether files require formatting (but not write directly to them), use the `--check` flag.
Expand Down