Skip to content

Commit f5fa4b5

Browse files
committed
Update README regarding shfmt .editorconfig support
1 parent 6e419da commit f5fa4b5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,15 @@ there is no `shfmt`-specific configuration variable for this. If your editor is
195195
two-space indents then that's what it will use. If you're using tabs for indentation then `shfmt`
196196
will use that.
197197

198+
The `shfmt` integration also supports configuration via `.editorconfig`. If any `shfmt`-specific
199+
configuration properties are found in `.editorconfig` then the config in `.editorconfig` will be
200+
used and the language server config will be ignored. This follows `shfmt`'s approach of using either
201+
`.editorconfig` or command line flags, but not both. Note that only `shfmt`-specific configuration
202+
properties are read from `.editorconfig` - indentation preferences are still provided by the editor,
203+
so to format using the indentation specified in `.editorconfig` make sure your editor is also
204+
configured to read `.editorconfig`. It is possible to disable `.editorconfig` support and always use
205+
the language server config by setting the "Ignore Editorconfig" configuration variable.
206+
198207
## Logging
199208

200209
The minimum logging level for the server can be adjusted using the `BASH_IDE_LOG_LEVEL` environment variable

0 commit comments

Comments
 (0)