X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/c7bc22388d30f1ba503eefd574e4bb794749b782..e818260f1a223929d8f2056f484b73eaa8687622:/README.md diff --git a/README.md b/README.md index 5b5903b..41ad465 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,13 @@ Options: -q, --quiet Don't emit non-error messages to stderr. Errors are still emitted, silence those with 2>/dev/null. + --pyi Consider all input files typing stubs regardless + of file extension (useful when piping source on + standard input). + --py36 Allow using Python 3.6-only syntax on all input + files. This will put trailing commas in function + signatures and calls also after *args and + **kwargs. [default: per-file auto-detection] --version Show the version and exit. --help Show this message and exit. ``` @@ -197,10 +204,26 @@ 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/) with +the following configuration. +
+A compatible `.isort.cfg` + +``` +[settings] +multi_line_output=3 +include_trailing_comma=True +force_grid_wrap=0 +combine_as_imports=True +line_length=88 +``` + +The equivalent command line is: +``` +$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width=88 [ file.py ] +``` +
### Line length @@ -521,6 +544,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`. @@ -653,6 +682,10 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.5b1 (unreleased) +* added `--pyi` (#249) + +* added `--py36` (#249) + * Python grammar pickle caches are stored with the formatting caches, making *Black* work in environments where site-packages is not user-writable (#192) @@ -666,7 +699,8 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * fixed unstable formatting when inline comments were moved around in a trailer that was omitted from line splitting on a large expression - (#238) + (#238) + ### 18.5b0