Add fast option to Black

Open
#2,041 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, python
Domain
tooling

Research direction

Start in plugin-maven/src/main/java/com/diffplug/spotless/maven/python/Black.java at the linked lines, where Black's arguments are handled. Check how the Maven integration invokes Black and add a way to pass the --fast option while preserving the default safe behavior. Done means users can select fast mode through the plugin configuration and the option reaches Black.

Written by the indexing model from the issue text.

Description

Black takes arguments. How do we pipe these in? For example, I'd like to send Black the --fast command-line arguments.

https://github.com/diffplug/spotless/blob/224f8f96df3ad42cac81064a0461e6d4ee91dcaf/plugin-maven/src/main/java/com/diffplug/spotless/maven/python/Black.java#L25-L31

We can add a property to run it fast:

--fast / --safe            By default, Black performs an AST safety
                                  check after formatting your code. The --fast
                                  flag turns off this check and the --safe
                                  flag explicitly enables it. [default:
                                  --safe]
Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.