From 6d4d4aa11d74d25c65ba5868bd17abba571dc3bd Mon Sep 17 00:00:00 2001 From: Peter Tripp Date: Mon, 3 Feb 2025 15:34:10 -0500 Subject: [PATCH] Document --stdin-filepath in README.md. Fixes #953 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 788430c6..a62d6153 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.