numtide/treefmt
1
1
Fork 0
mirror of https://github.com/numtide/treefmt.git synced 2024-08-17 04:40:27 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

README: improve description (#108)

Browse Source
This commit is contained in:
Jonas Chevalier 2021-05-07 21:13:56 +02:00 committed by GitHub
parent 4e10f88b6f
commit c669ddb0da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -9,16 +9,17 @@
[![Support room on Matrix](https://img.shields.io/matrix/treefmt:numtide.com.svg?label=%23treefmt%3Anumtide.com&logo=matrix&server_fqdn=matrix.numtide.com)](https://matrix.to/#/#treefmt:numtide.com)
**Status: experimental** -- not all features described here are working
yet.
**Status: alpha**
Every project has different languages and set of code formatters, with
different configurations. When jumping between projects, it always takes a bit
of time to get accustomed to them and update the editor configuration.
When working on large code trees, it's common to have multiple code
formatters run against it. And have one script that loops over all of them.
`treefmt` makes that nicer.
This project solves that problem by proposing a unified CLI interface that
traverses the project file tree and maps each file to a different code
formatter. Type `treefmt`, and it re-formats the repository.
- A unified CLI and output
- Run all the formatters in parallel.
- Cache which files have changed for super fast re-formatting.
Just type `treefmt` in any folder and it reformats the whole code tree.
## Design decisions