Skip to content

Commit 855eb9a

Browse files
committed
docs(README): update motivation
This maps a bit better to what I had in mind when I started the project.
1 parent 5892f1a commit 855eb9a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@ _A <a href="https://numtide.com/">numtide</a> project._
2121

2222
## Motivation
2323

24-
It’s common to format code according to the project’s standards before making contributions to any project. This task
25-
seems trivial at first sight — you can set up the required language formatter in your IDE.
24+
Modern code repositories are rarely written in a single language. They often contain a mix of languages, each with its own formatting requirements.
2625

27-
However, contributing to multiple projects requires more effort: you must change your formatter configurations each
28-
time you switch between projects or call them manually.
26+
While working for our customers, we noticed that projects each tended to re-implement the same formatter multiplexing logic. A script that invokes all the formatters.
2927

30-
Formatting requires less effort with a universal formatter that supports multiple languages but is still project-specific.
28+
What if that script was a single command?
29+
30+
What if that single command would handle all the formatters in parallel? And only format files that have changed since the previous run?
31+
32+
That's what treefmt is about.
3133

3234
## About treefmt
3335

0 commit comments

Comments
 (0)