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

doc: refine faq

Browse Source 
Signed-off-by: Brian McGee <brian@bmcgee.ie>
This commit is contained in:
Brian McGee 2024-05-01 14:10:45 +01:00
parent 4d60509e13
commit 6070b6f6e4
Signed by: brianmcgee
GPG Key ID: D49016E76AD1E8C0
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/faq.md
View File

@ -2,18 +2,27 @@
## 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.
`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.
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 this moment, the cache is represented by a flat TOML file where file paths are mapped to `mtimes`. The file is located in:
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/<hash-of-the-treefmt.toml-path>.toml
~/.cache/treefmt/eval-cache/<hash-of-the-treefmt.toml-path>.db
```
However, we are planning to move the hash file to the destination project's root directory.
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.
At the end of each tool run, the cache file gets overwritten with the last formatting time entries. In this way, we can 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