Compare commits

...

3 Commits

Author SHA1 Message Date
e3fabb17e8
doc: update usage with info about walkers.
Signed-off-by: Brian McGee <brian@bmcgee.ie>
2024-05-02 11:52:29 +01:00
352dfff6e1
doc: update stats in overview
Signed-off-by: Brian McGee <brian@bmcgee.ie>
2024-05-02 11:52:29 +01:00
92f8d58015
doc: update fmt.gif
Signed-off-by: Brian McGee <brian@bmcgee.ie>
2024-05-02 11:52:17 +01:00
3 changed files with 15 additions and 9 deletions

View File

@ -44,22 +44,22 @@ formatters run only against them. Moreover, formatters are run in parallel, whic
The difference may not be significant for smaller projects, but it gets quite visible as the project grows. For
instance, take the caching optimization.
It takes 22 seconds to traverse a project of 40,559 files and no changes without caching:
It takes about 23 seconds to traverse a project of 40,559 files and no changes without caching:
```
traversed 40559 files
emitted 40559 files for processing
matched 33712 files to formatters
formatted 33712 files in 22.270884528s
traversed 41273 files
emitted 41273 files for processing
matched 34311 files to formatters
formatted 14338 files in 23.679339987s
```
...while it takes **270 milliseconds** to traverse the same project with caching:
...while it takes **239 milliseconds** to traverse the same project with caching:
```
traversed 40559 files
emitted 6847 files for processing
traversed 41273 files
emitted 0 files for processing
matched 0 files to formatters
formatted 0 files in 270.53513ms
formatted 0 files in 239.024064ms
```
The tool can be invoked manually or integrated into your CI. There's currently no integration with IDEs, but the feature is coming soon.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

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.