]>
git.madduck.net Git - etc/vim.git/blobdiff - 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:
+1. Install _Black_ with the `d` extra .
+ $ pip install 'black[d]'
-1. Locate your `black` installation folder.
+1. Install
+ [BlackConnect IntelliJ IDEs plugin](https://plugins.jetbrains.com/plugin/14321-blackconnect).
- On macOS / Linux / BSD:
-
- ```console
- $ which black
- /usr/local/bin/black # possible location
- ```
-
- On Windows:
-
- ```console
- $ where black
- %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # possible location
- ```
-
- Note that if you are using a virtual environment detected by PyCharm, this is an
- unneeded step. In this case the path to `black` is `$PyInterpreterDirectory$/black`.
-
-1. Open External tools in PyCharm/IntelliJ IDEA
+1. Open plugin configuration in PyCharm/IntelliJ IDEA
- `PyCharm -> Preferences -> Tools -> External Tools `
+ `PyCharm -> Preferences -> Tools -> BlackConnect `
On Windows / Linux / BSD:
On Windows / Linux / BSD:
- `File -> Settings -> Tools -> External Tools`
-
-1. Click the + icon to add a new external tool with the following values:
+ `File -> Settings -> Tools -> BlackConnect`
- - Name: Black
- - Description: Black is the uncompromising Python code formatter.
- - Program: \<install_location_from_step_2>
- - Arguments: `"$FilePath$"`
+1. In `Local Instance (shared between projects)` section:
-1. Format the currently opened file by selecting `Tools -> External Tools -> black`.
+ 1. Check `Start local blackd instance when plugin loads`.
+ 1. Press the `Detect` button near `Path` input. The plugin should detect the `blackd`
+ executable.
- - Alternatively, you can set a keyboard shortcut by navigating to
- `Preferences or Settings -> Keymap -> External Tools -> External Tools - Black` .
+1. In `Trigger Settings` section check `Trigger on code reformat` to enable code
+ reformatting with _Black_ .
-1. Optionally, run _Black_ on every file save:
+1. Format the currently opened file by selecting `Code -> Reformat Code` or using a
+ shortcut.
- 1. Make sure you have the
- [File Watchers](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin
- installed.
- 1. Go to `Preferences or Settings -> Tools -> File Watchers` and click `+` to add a
- new watcher:
- - Name: Black
- - File type: Python
- - Scope: Project Files
- - Program: \<install_location_from_step_2>
- - Arguments: `$FilePath$`
- - Output paths to refresh: `$FilePath$`
- - Working directory: `$ProjectFileDir$`
+1. Optionally, to run _Black_ on every file save:
- - In Advanced Options
- - Uncheck "Auto-save edited files to trigger the watcher"
- - Uncheck "Trigger the watcher on external changes"
+ - In `Trigger Settings` section of plugin configuration check
+ `Trigger when saving changed files`.
- `g:black_skip_string_normalization` (defaults to `0`)
- `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)
- `g:black_quiet` (defaults to `0`)
- `g:black_skip_string_normalization` (defaults to `0`)
- `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)
- `g:black_quiet` (defaults to `0`)
+- `g:black_preview` (defaults to `0`)
To install with [vim-plug](https://github.com/junegunn/vim-plug):
To install with [vim-plug](https://github.com/junegunn/vim-plug):
Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or
Pathogen, and so on.
Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or
Pathogen, and so on.
-This plugin **requires Vim 7.0+ built with Python 3.6+ support**. It needs Python 3.6 to
+This plugin **requires Vim 7.0+ built with Python 3.7+ support**. It needs Python 3.7 to
be able to run _Black_ inside the Vim process which is much faster than calling an
external command.
be able to run _Black_ inside the Vim process which is much faster than calling an
external command.
projects / etc / vim.git / blobdiff