Skip to content

Commit

Permalink
Add Black PyCharm 2023.2 integration instructions (#3839)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonashaag authored Sep 8, 2023
1 parent 8daa64a commit 74d3009
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions docs/integrations/editors.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,26 @@ Options include the following:

## PyCharm/IntelliJ IDEA

There are three different ways you can use _Black_ from PyCharm:
There are several different ways you can use _Black_ from PyCharm:

1. As local server using the BlackConnect plugin
1. As external tool
1. As file watcher
1. Using the built-in _Black_ integration (PyCharm 2023.2 and later). This option is the
simplest to set up.
1. As local server using the BlackConnect plugin. This option formats the fastest. It
spins up {doc}`Black's HTTP server </usage_and_configuration/black_as_a_server>`, to
avoid the startup cost on subsequent formats.
1. As external tool.
1. As file watcher.

The first option is the simplest to set up and formats the fastest (by spinning up
{doc}`Black's HTTP server </usage_and_configuration/black_as_a_server>`, avoiding the
startup cost on subsequent formats), but if you would prefer to not install a
third-party plugin or blackd's extra dependencies, the other two are also great options.
### Built-in _Black_ integration

1. Install `black`.

```console
$ pip install black
```

1. Go to `Preferences or Settings -> Tools -> Black` and configure _Black_ to your
liking.

### As local server

Expand Down

0 comments on commit 74d3009

Please sign in to comment.