X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/639b62dcd32cde3645e9f9a633eee33c04d23901..337a4199f90ca48a19cf26511e0cec330b13bd4e:/README.md diff --git a/README.md b/README.md index ed1e019..05bff36 100644 --- a/README.md +++ b/README.md @@ -368,9 +368,21 @@ Configuration: * `g:black_linelength` (defaults to `88`) * `g:black_virtualenv` (defaults to `~/.vim/black`) -To install, copy the plugin from [vim/plugin/black.vim](https://github.com/ambv/black/tree/master/vim/plugin/black.vim). +To install with [vim-plug](https://github.com/junegunn/vim-plug): + +``` +Plug 'ambv/black', +``` + +or with [Vundle](https://github.com/VundleVim/Vundle.vim): + +``` +Plugin 'ambv/black' +``` + +or you can copy the plugin from [plugin/black.vim](https://github.com/ambv/black/tree/master/plugin/black.vim). Let me know if this requires any changes to work with Vim 8's builtin -`packadd`, or Pathogen, or Vundle, and so on. +`packadd`, or Pathogen, and so on. This plugin **requires Vim 7.0+ built with Python 3.6+ support**. It needs Python 3.6 to be able to run *Black* inside the Vim process which @@ -445,12 +457,12 @@ master, this is also an option. *Black* remembers files it already formatted, unless the `--diff` flag is used or code is passed via standard input. This information is stored per-user. The exact location of the file depends on the black version and the system on which black -is run. The file is non-portable. The standard location on common operating systems +is run. The file is non-portable. The standard location on common operating systems is: -* Windows: `C:\\Users\\AppData\Local\black\black\Cache\\cache.pkl` -* macOS: `/Users//Library/Caches/black//cache.pkl` -* Linux: `/home//.cache/black//cache.pkl` +* Windows: `C:\\Users\\AppData\Local\black\black\Cache\\cache.pickle` +* macOS: `/Users//Library/Caches/black//cache.pickle` +* Linux: `/home//.cache/black//cache.pickle` ## Testimonials @@ -508,13 +520,24 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log -### 18.4a3 +### 18.4a3 (unreleased) + +* added a "cache"; files already reformatted that haven't changed on disk + won't be reformatted again (#109) + +* `--check` and `--diff` are no longer mutually exclusive (#149) * generalized star expression handling, including double stars; this fixes multiplication making expressions "unsafe" for trailing commas (#132) -* fix parsing of complex expressions after star and double stars in - function parameters (#2) +* fixed comment indentation when a standalone comment closes a block (#16, #32) + +* fixed `--diff` not showing entire path (#130) + +* fixed parsing of complex expressions after star and double stars in + function calls (#2) + +* fixed invalid splitting on comma in lambda arguments (#133) ### 18.4a2 @@ -677,4 +700,6 @@ Multiple contributions by: * [Eli Treuherz](mailto:eli.treuherz@cgi.com) * Hugo van Kemenade * [Ivan Katanić](mailto:ivan.katanic@gmail.com) +* [Jonas Obrist](mailto:ojiidotch@gmail.com) * [Osaetin Daniel](mailto:osaetindaniel@gmail.com) +* [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)