A lot of the time, your change will affect formatting and/or performance. Quantifying these changes is hard, so we have tooling to help make it easier.
It's recommended you evaluate the quantifiable changes your Black formatting modification causes before submitting a PR. Think about if the change seems disruptive enough to cause frustration to projects that are already "black formatted".
black-primer
is a tool built for CI (and humans) to have Black --check
a number of
Git accessible projects in parallel. (configured in primer.json
) (A PR will be
accepted to add Mercurial support.)
- Ensure we have a
black
+git
in PATH - Load projects from
primer.json
- Run projects in parallel with
--worker
workers (defaults to CPU count / 2)- Checkout projects
- Run black and record result
- Clean up repository checkout (can optionally be disabled via
--keep
)
- Display results summary to screen
- Default to cleaning up
--work-dir
(which defaults to tempfile schemantics) - Return
- 0 for successful run
- < 0 for environment / internal error
- > 0 for each project with an error
If you're running locally yourself to test black on lots of code try:
- Using
-k
/--keep
+-w
/--work-dir
so you don't have to re-checkout the repo each run