numtide/treefmt
Archived
8
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

doc: update usage with info about walkers.

Browse Source 
Signed-off-by: Brian McGee <brian@bmcgee.ie>
This commit is contained in:
Brian McGee 2024-05-02 11:52:01 +01:00
parent 352dfff6e1
commit e3fabb17e8
Signed by: brianmcgee
GPG Key ID: D49016E76AD1E8C0
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/usage.md
View File

@ -16,6 +16,12 @@ treefmt [FLAGS] [OPTIONS] [--] [paths]...
## Flags
`--walk <auto|git|filesystem>`
> The method used to traverse the files within `<tree-root>`.
> Default is `auto`, where we will detect if the `<tree-root>` is a git repository and use the `git` walker for
> traversal. If not we will fall back to the `filesystem` walker.
`--allow-missing-formatter`
> Do not exit with an error if some of the configured formatters are missing.