numtide/treefmt
1
1
Fork 0
mirror of https://github.com/numtide/treefmt.git synced 2024-10-05 21:17:37 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: document the global format

Browse Source
This commit is contained in:
zimbatm 2024-05-30 14:08:58 +02:00
parent 022398399f
commit 93955bbc3c
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/configure.md
View File

@ -41,14 +41,14 @@ priority = 1
## Global Options
- `excludes` - an optional list of glob patters used to exclude certain files from all formatters.
- `excludes` - an optional list of [glob patterns](#glob-patterns-format) used to exclude certain files from all formatters.
## Formatter Options
- `command` - the command to invoke when applying the formatter.
- `options` - an optional list of args to be passed to `command`.
- `includes` - a list of glob patterns used to determine whether the formatter should be applied against a given path.
- `excludes` - an optional list of glob patterns used to exclude certain files from this formatter.
- `includes` - a list of [glob patterns](#glob-patterns-format) used to determine whether the formatter should be applied against a given path.
- `excludes` - an optional list of [glob patterns](#glob-patterns-format) used to exclude certain files from this formatter.
- `priority` - influences the order of execution. Greater precedence is given to lower numbers, with the default being `0`.
## Same file, multiple formatters?
@ -65,6 +65,16 @@ Another consequence is that formatting is deterministic for a given file and a g
By setting the priority fields appropriately, you can control the order in which those formatters are applied for any
files they _both happen to match on_.
## Glob patterns format
This is a variant of the Unix glob pattern. It supports all the usual
selectors such as `*` and `?`.
### Examples
- `*.go` - match all files in the project that end with a ".go" file extension.
- `vendor/*` - match all files under the vendor folder, recursively.
## Supported Formatters
Here is a list of all the formatters we tested. Feel free to send a PR to add other ones!