X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/bbed104e6d3e89ebb8da7c209b842e8a96bcd5de..d320e283aa6698ea7f7b80e2ff6f58a864fcfe0f:/README.md diff --git a/README.md b/README.md index 8212e42..e5a3036 100644 --- a/README.md +++ b/README.md @@ -204,10 +204,20 @@ If a data structure literal (tuple, list, set, dict) or a line of "from" imports cannot fit in the allotted length, it's always split into one element per line. This minimizes diffs as well as enables readers of code to find which commit introduced a particular entry. This also -makes *Black* compatible with [isort](https://pypi.org/p/isort/). Use -`multi_line_output=3`, `include_trailing_comma=True`, -`force_grid_wrap=0`, and `line_length=88` in your isort config. +makes *Black* compatible with [isort](https://pypi.org/p/isort/). +If you do wish to use *Black* alongside `isort`, you can pass the following +command-line arguments to ensure compatible behaviour: +``` +$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --line-width=88 [ file.py ] +``` +Or use the equivalent directives in your isort config: +``` +multi_line_output=3 +include_trailing_comma=True +force_grid_wrap=0 +line_length=88 +``` ### Line length @@ -528,6 +538,12 @@ install *Black* (for example you want to run a version from master), create a virtualenv manually and point `g:black_virtualenv` to it. The plugin will use it. +To run *Black* on save, add the following line to `.vimrc` or `init.vim`: + +``` +autocmd BufWritePost *.py execute ':Black' +``` + **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 --with-python3`.