X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/230f1d277c96ff7d19b7b86ce2446d4639e54d3c..fd9bd07fe551c88f0c1e2d6f411f48b73f3083fc:/README.md diff --git a/README.md b/README.md index 77b077c..a6d7de8 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. ``` @@ -521,6 +528,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,10 +666,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.5b1 (unreleased) -* Added `--pyi` option to force pyi-style formatting (regardless of file - extension, or when piping source to *Black*), and `--py36` option to force - allowing Py36 syntax (e.g. trailing commas after `*args` or `**kwargs`), even - if the file doesn't currently use any 3.6-only syntax (#249) +* 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) @@ -673,6 +685,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). a trailer that was omitted from line splitting on a large expression (#238) + ### 18.5b0 * call chains are now formatted according to the