Skip to content

Commit

Permalink
docs: fix inconsistent includes documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
a-kenji committed Sep 29, 2023
1 parent a59131b commit 7f0b94d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/treefmt-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

`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:

```
[formatter.<name>]
command = "<formatter-command>"
options = ["<formatter-option-1>"...]
includes = ["<regular-expression>"]
includes = ["<glob-pattern>"...]
```

...where name is just an identifier.
Expand Down

0 comments on commit 7f0b94d

Please sign in to comment.