numtide/treefmt
1
1
Fork 0
mirror of https://github.com/numtide/treefmt.git synced 2024-08-16 20:30:25 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: fix inconsistent includes documentation (#249)

Browse Source
This commit is contained in:
a-kenji 2023-09-29 18:31:06 +02:00 committed by GitHub
parent e1ca0bc7ca
commit 2e129d929a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/treefmt-configuration.md
View File

@ -2,7 +2,7 @@
`treefmt` can only be run in the presence of `treefmt.toml` where files are mapped to specific code formatters.
Usually the config file sits in the project root folder. If you're running `treefmt` in one of the project's folders, then `treefmt` will look for the config in the parent folders up until the project's root. However, you can place the config anywhere in your project's file tree and specify the path in the the ---config-file flag.
Usually the config file sits in the project root folder. If you're running `treefmt` in one of the project's folders, then `treefmt` will look for the config in the parent folders up until the project's root. However, you can place the config anywhere in your project's file tree and specify the path in the ---config-file flag.
The typical section of `treefmt.toml` looks like this:
@ -10,7 +10,7 @@ The typical section of `treefmt.toml` looks like this:
[formatter.<name>]
command = "<formatter-command>"
options = ["<formatter-option-1>"...]
includes = ["<regular-expression>"]
includes = ["<glob-pattern>"...]
```
...where name is just an identifier.