Skip to content

Vim plugin docs improvements #3468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Dec 20, 2022
Merged

Vim plugin docs improvements #3468

Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
26c56f2
Organize vim plugin section with headers to separate out Installation…
matthewarmand Dec 20, 2022
9929893
Add missing plugin configuration options, with current defaults
matthewarmand Dec 20, 2022
bb0f446
Add installation note for Arch Linux, now that the plugin is shipped …
matthewarmand Dec 20, 2022
1a73b72
Fix vim-plug specification to follow stable releases. Moving the same…
matthewarmand Dec 20, 2022
197edbd
put the ale plugin back, i moved it misinterpreting where it should go
matthewarmand Dec 20, 2022
72667be
praise to the linter
matthewarmand Dec 20, 2022
ebe7219
maintainer feedback, expand the vim-plug section a bit and add a chan…
matthewarmand Dec 20, 2022
1c45927
fix broken docs link
matthewarmand Dec 20, 2022
58c1080
feedback, move installation note to the installation section (crazy r…
matthewarmand Dec 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion docs/integrations/editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,16 +111,25 @@ Configuration:
- `g:black_fast` (defaults to `0`)
- `g:black_linelength` (defaults to `88`)
- `g:black_skip_string_normalization` (defaults to `0`)
- `g:black_skip_magic_trailing_comma` (defaults to `0`)
- `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)
- `g:black_use_virtualenv` (defaults to `1`)
- `g:black_target_version` (defaults to `""`)
- `g:black_quiet` (defaults to `0`)
- `g:black_preview` (defaults to `0`)

#### Installation

##### `vim-plug`

To install with [vim-plug](https://github.com/junegunn/vim-plug):

```
Plug 'psf/black', { 'branch': 'stable' }
Plug 'psf/black', { 'tag': '*.*.*' }
```

##### Vundle

or with [Vundle](https://github.com/VundleVim/Vundle.vim):

```
Expand All @@ -134,6 +143,13 @@ $ cd ~/.vim/bundle/black
$ git checkout origin/stable -b stable
```

##### Arch Linux

On Arch Linux, the plugin is shipped with the [`python-black`](https://archlinux.org/packages/community/any/python-black/)
package, so you can start using it in Vim after install with no additional setup.

##### Vim 8 Native Plugin Management

or you can copy the plugin files from
[plugin/black.vim](https://github.com/psf/black/blob/stable/plugin/black.vim) and
[autoload/black.vim](https://github.com/psf/black/blob/stable/autoload/black.vim).
Expand All @@ -148,6 +164,8 @@ curl https://raw.githubusercontent.com/psf/black/stable/autoload/black.vim -o ~/
Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or
Pathogen, and so on.

#### Usage

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.
Expand Down Expand Up @@ -187,6 +205,8 @@ To run _Black_ on a key press (e.g. F9 below), add this:
nnoremap <F9> :Black<CR>
```

#### Troubleshooting

**How to get Vim with Python 3.6?** On Ubuntu 17.10 Vim comes with Python 3.6 by
default. On macOS with Homebrew run: `brew install vim`. When building Vim from source,
use: `./configure --enable-python3interp=yes`. There's many guides online how to do
Expand Down