Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document --stdin-filepath in README.md #954

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document --stdin-filepath in README.md #954

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
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,16 @@ 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` and `--respect-ignores` to use glob filtering
via `-g` or via `.styluaignore` to ignore certain files.

```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