Skip to content

Commit

Permalink
docs(README): update motivation
Browse files Browse the repository at this point in the history
This maps a bit better to what I had in mind when I started the project.
  • Loading branch information
zimbatm committed Dec 17, 2024
1 parent 55c18c0 commit a993f21
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@ _A <a href="https://numtide.com/">numtide</a> project._

## Motivation

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

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

Formatting requires less effort with a universal formatter that supports multiple languages but is still project-specific.
What if that script was a single command?

What if that single command would handle all the formatters in parallel, and only format the files that have changed?

That's what treefmt is about.

## About treefmt

Expand Down

0 comments on commit a993f21

Please sign in to comment.