chore(bins): sync stylua README

This commit is contained in:
Erica Marigold 2025-04-21 16:01:01 +01:00
parent bfb2fb8b9f
commit 5eb7ad010f
Signed by: DevComp
SSH key fingerprint: SHA256:jD3oMT4WL3WHPJQbrjC3l5feNCnkv7ndW8nYaHX5wFw

View file

@ -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) - 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) - 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 ## Usage
@ -154,6 +155,15 @@ vendor/
running `stylua .` will ignore the `vendor/` directory. 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 ### `--check`: Checking files for formatting
To check whether files require formatting (but not write directly to them), use the `--check` flag. To check whether files require formatting (but not write directly to them), use the `--check` flag.