]> git.madduck.net Git - etc/vim.git/blob - docs/integrations/editors.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Remove `language_version` for pre-commit (#2430)
[etc/vim.git] / docs / integrations / editors.md
1 # Editor integration
2
3 ## Emacs
4
5 Options include the following:
6
7 - [wbolster/emacs-python-black](https://github.com/wbolster/emacs-python-black)
8 - [proofit404/blacken](https://github.com/pythonic-emacs/blacken)
9 - [Elpy](https://github.com/jorgenschaefer/elpy).
10
11 ## PyCharm/IntelliJ IDEA
12
13 1. Install `black`.
14
15    ```console
16    $ pip install black
17    ```
18
19 1. Locate your `black` installation folder.
20
21    On macOS / Linux / BSD:
22
23    ```console
24    $ which black
25    /usr/local/bin/black  # possible location
26    ```
27
28    On Windows:
29
30    ```console
31    $ where black
32    %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
33    ```
34
35    Note that if you are using a virtual environment detected by PyCharm, this is an
36    unneeded step. In this case the path to `black` is `$PyInterpreterDirectory$/black`.
37
38 1. Open External tools in PyCharm/IntelliJ IDEA
39
40    On macOS:
41
42    `PyCharm -> Preferences -> Tools -> External Tools`
43
44    On Windows / Linux / BSD:
45
46    `File -> Settings -> Tools -> External Tools`
47
48 1. Click the + icon to add a new external tool with the following values:
49
50    - Name: Black
51    - Description: Black is the uncompromising Python code formatter.
52    - Program: \<install_location_from_step_2>
53    - Arguments: `"$FilePath$"`
54
55 1. Format the currently opened file by selecting `Tools -> External Tools -> black`.
56
57    - Alternatively, you can set a keyboard shortcut by navigating to
58      `Preferences or Settings -> Keymap -> External Tools -> External Tools - Black`.
59
60 1. Optionally, run _Black_ on every file save:
61
62    1. Make sure you have the
63       [File Watchers](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin
64       installed.
65    1. Go to `Preferences or Settings -> Tools -> File Watchers` and click `+` to add a
66       new watcher:
67       - Name: Black
68       - File type: Python
69       - Scope: Project Files
70       - Program: \<install_location_from_step_2>
71       - Arguments: `$FilePath$`
72       - Output paths to refresh: `$FilePath$`
73       - Working directory: `$ProjectFileDir$`
74
75    - In Advanced Options
76      - Uncheck "Auto-save edited files to trigger the watcher"
77      - Uncheck "Trigger the watcher on external changes"
78
79 ## Wing IDE
80
81 Wing supports black via the OS Commands tool, as explained in the Wing documentation on
82 [pep8 formatting](https://wingware.com/doc/edit/pep8). The detailed procedure is:
83
84 1. Install `black`.
85
86    ```console
87    $ pip install black
88    ```
89
90 1. Make sure it runs from the command line, e.g.
91
92    ```console
93    $ black --help
94    ```
95
96 1. In Wing IDE, activate the **OS Commands** panel and define the command **black** to
97    execute black on the currently selected file:
98
99    - Use the Tools -> OS Commands menu selection
100    - click on **+** in **OS Commands** -> New: Command line..
101      - Title: black
102      - Command Line: black %s
103      - I/O Encoding: Use Default
104      - Key Binding: F1
105      - [x] Raise OS Commands when executed
106      - [x] Auto-save files before execution
107      - [x] Line mode
108
109 1. Select a file in the editor and press **F1** , or whatever key binding you selected
110    in step 3, to reformat the file.
111
112 ## Vim
113
114 ### Official plugin
115
116 Commands and shortcuts:
117
118 - `:Black` to format the entire file (ranges not supported);
119 - `:BlackUpgrade` to upgrade _Black_ inside the virtualenv;
120 - `:BlackVersion` to get the current version of _Black_ inside the virtualenv.
121
122 Configuration:
123
124 - `g:black_fast` (defaults to `0`)
125 - `g:black_linelength` (defaults to `88`)
126 - `g:black_skip_string_normalization` (defaults to `0`)
127 - `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)
128 - `g:black_quiet` (defaults to `0`)
129
130 To install with [vim-plug](https://github.com/junegunn/vim-plug):
131
132 ```
133 Plug 'psf/black', { 'branch': 'stable' }
134 ```
135
136 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
137
138 ```
139 Plugin 'psf/black'
140 ```
141
142 and execute the following in a terminal:
143
144 ```console
145 $ cd ~/.vim/bundle/black
146 $ git checkout origin/stable -b stable
147 ```
148
149 or you can copy the plugin files from
150 [plugin/black.vim](https://github.com/psf/black/blob/stable/plugin/black.vim) and
151 [autoload/black.vim](https://github.com/psf/black/blob/stable/autoload/black.vim).
152
153 ```
154 mkdir -p ~/.vim/pack/python/start/black/plugin
155 mkdir -p ~/.vim/pack/python/start/black/autoload
156 curl https://raw.githubusercontent.com/psf/black/stable/plugin/black.vim -o ~/.vim/pack/python/start/black/plugin/black.vim
157 curl https://raw.githubusercontent.com/psf/black/stable/autoload/black.vim -o ~/.vim/pack/python/start/black/autoload/black.vim
158 ```
159
160 Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or
161 Pathogen, and so on.
162
163 This plugin **requires Vim 7.0+ built with Python 3.6+ support**. It needs Python 3.6 to
164 be able to run _Black_ inside the Vim process which is much faster than calling an
165 external command.
166
167 On first run, the plugin creates its own virtualenv using the right Python version and
168 automatically installs _Black_. You can upgrade it later by calling `:BlackUpgrade` and
169 restarting Vim.
170
171 If you need to do anything special to make your virtualenv work and install _Black_ (for
172 example you want to run a version from main), create a virtualenv manually and point
173 `g:black_virtualenv` to it. The plugin will use it.
174
175 To run _Black_ on save, add the following line to `.vimrc` or `init.vim`:
176
177 ```
178 autocmd BufWritePre *.py execute ':Black'
179 ```
180
181 To run _Black_ on a key press (e.g. F9 below), add this:
182
183 ```
184 nnoremap <F9> :Black<CR>
185 ```
186
187 **How to get Vim with Python 3.6?** On Ubuntu 17.10 Vim comes with Python 3.6 by
188 default. On macOS with Homebrew run: `brew install vim`. When building Vim from source,
189 use: `./configure --enable-python3interp=yes`. There's many guides online how to do
190 this.
191
192 **I get an import error when using _Black_ from a virtual environment**: If you get an
193 error message like this:
194
195 ```text
196 Traceback (most recent call last):
197   File "<string>", line 63, in <module>
198   File "/home/gui/.vim/black/lib/python3.7/site-packages/black.py", line 45, in <module>
199     from typed_ast import ast3, ast27
200   File "/home/gui/.vim/black/lib/python3.7/site-packages/typed_ast/ast3.py", line 40, in <module>
201     from typed_ast import _ast3
202 ImportError: /home/gui/.vim/black/lib/python3.7/site-packages/typed_ast/_ast3.cpython-37m-x86_64-linux-gnu.so: undefined symbool: PyExc_KeyboardInterrupt
203 ```
204
205 Then you need to install `typed_ast` and `regex` directly from the source code. The
206 error happens because `pip` will download [Python wheels](https://pythonwheels.com/) if
207 they are available. Python wheels are a new standard of distributing Python packages and
208 packages that have Cython and extensions written in C are already compiled, so the
209 installation is much more faster. The problem here is that somehow the Python
210 environment inside Vim does not match with those already compiled C extensions and these
211 kind of errors are the result. Luckily there is an easy fix: installing the packages
212 from the source code.
213
214 The two packages that cause the problem are:
215
216 - [regex](https://pypi.org/project/regex/)
217 - [typed-ast](https://pypi.org/project/typed-ast/)
218
219 Now remove those two packages:
220
221 ```console
222 $ pip uninstall regex typed-ast -y
223 ```
224
225 And now you can install them with:
226
227 ```console
228 $ pip install --no-binary :all: regex typed-ast
229 ```
230
231 The C extensions will be compiled and now Vim's Python environment will match. Note that
232 you need to have the GCC compiler and the Python development files installed (on
233 Ubuntu/Debian do `sudo apt-get install build-essential python3-dev`).
234
235 If you later want to update _Black_, you should do it like this:
236
237 ```console
238 $ pip install -U black --no-binary regex,typed-ast
239 ```
240
241 ### With ALE
242
243 1. Install [`ale`](https://github.com/dense-analysis/ale)
244
245 1. Install `black`
246
247 1. Add this to your vimrc:
248
249    ```vim
250    let g:ale_fixers = {}
251    let g:ale_fixers.python = ['black']
252    ```
253
254 ## Gedit
255
256 gedit is the default text editor of the GNOME, Unix like Operating Systems. Open gedit
257 as
258
259 ```console
260 $ gedit <file_name>
261 ```
262
263 1. `Go to edit > preferences > plugins`
264 1. Search for `external tools` and activate it.
265 1. In `Tools menu -> Manage external tools`
266 1. Add a new tool using `+` button.
267 1. Copy the below content to the code window.
268
269 ```console
270 #!/bin/bash
271 Name=$GEDIT_CURRENT_DOCUMENT_NAME
272 black $Name
273 ```
274
275 - Set a keyboard shortcut if you like, Ex. `ctrl-B`
276 - Save: `Nothing`
277 - Input: `Nothing`
278 - Output: `Display in bottom pane` if you like.
279 - Change the name of the tool if you like.
280
281 Use your keyboard shortcut or `Tools -> External Tools` to use your new tool. When you
282 close and reopen your File, _Black_ will be done with its job.
283
284 ## Visual Studio Code
285
286 Use the
287 [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
288 ([instructions](https://code.visualstudio.com/docs/python/editing#_formatting)).
289
290 ## SublimeText 3
291
292 Use [sublack plugin](https://github.com/jgirardet/sublack).
293
294 ## Jupyter Notebook Magic
295
296 Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
297
298 ## Python LSP Server
299
300 If your editor supports the [Language Server Protocol](https://langserver.org/) (Atom,
301 Sublime Text, Visual Studio Code and many more), you can use the
302 [Python LSP Server](https://github.com/python-lsp/python-lsp-server) with the
303 [python-lsp-black](https://github.com/python-lsp/python-lsp-black) plugin.
304
305 ## Atom/Nuclide
306
307 Use [python-black](https://atom.io/packages/python-black) or
308 [formatters-python](https://atom.io/packages/formatters-python).
309
310 ## Gradle (the build tool)
311
312 Use the [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-gradle) plugin.
313
314 ## Kakoune
315
316 Add the following hook to your kakrc, then run _Black_ with `:format`.
317
318 ```
319 hook global WinSetOption filetype=python %{
320     set-option window formatcmd 'black -q  -'
321 }
322 ```
323
324 ## Thonny
325
326 Use [Thonny-black-code-format](https://github.com/Franccisco/thonny-black-code-format).