29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
# FAQ
|
|
|
|
## How does treefmt function?
|
|
|
|
`Treefmt` traverses all your project's folders, maps files to specific code formatters, and formats the code
|
|
accordingly. Other tools also traverse the filesystem, but not necessarily starting from the root of the project.
|
|
|
|
Contrary to other formatters, `treefmt` doesn't preview the changes before writing them to a file. If you want to view
|
|
the changes, you can always check the diff in your version control (we assume that your project is checked into a
|
|
version control system).
|
|
|
|
You can also rely on version control if errors were introduced into your code as a result of disruptions in the
|
|
formatter's work.
|
|
|
|
## How is the cache organized?
|
|
|
|
At the moment, the cache is a [BoltDB] database file in which file paths are mapped to `mtimes`.
|
|
|
|
The file is located in:
|
|
|
|
```
|
|
~/.cache/treefmt/eval-cache/<hash-of-the-treefmt.toml-path>.db
|
|
```
|
|
|
|
At the end of each run, the database is updated with the last formatting time entries. In this way, we can
|
|
compare the last change time of the file to the last formatting time, and figure out which files need re-formatting.
|
|
|
|
[BoltDB]: https://github.com/etcd-io/bbolt
|