]> git.madduck.net Git - etc/vim.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Update README.md (#906)
[etc/vim.git] / README.md
index ddb160d4af561e2bc5f91c5e4360ffde9f7b0f34..ddca8a4152a95e1ab6d1388328b9f8a64db643ff 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 <h2 align="center">The Uncompromising Code Formatter</h2>
 
 <p align="center">
 <h2 align="center">The Uncompromising Code Formatter</h2>
 
 <p align="center">
-<a href="https://travis-ci.org/psf/black"><img alt="Build Status" src="https://travis-ci.org/psf/black.svg?branch=master"></a>
+<a href="https://travis-ci.com/psf/black"><img alt="Build Status" src="https://travis-ci.com/psf/black.svg?branch=master"></a>
 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
 <a href="https://coveralls.io/github/psf/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=master"></a>
 <a href="https://github.com/psf/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
 <a href="https://coveralls.io/github/psf/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=master"></a>
 <a href="https://github.com/psf/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
@@ -178,14 +178,14 @@ great.
 ```py3
 # in:
 
 ```py3
 # in:
 
-l = [1,
+j = [1,
      2,
      3,
 ]
 
 # out:
 
      2,
      3,
 ]
 
 # out:
 
-l = [1, 2, 3]
+j = [1, 2, 3]
 ```
 
 If not, *Black* will look at the contents of the first outer matching
 ```
 
 If not, *Black* will look at the contents of the first outer matching
@@ -297,7 +297,7 @@ ignore = E501,W503,E203
 ```
 
 You'll find *Black*'s own .flake8 config file is configured like this.
 ```
 
 You'll find *Black*'s own .flake8 config file is configured like this.
-If you're curious about the reasoning behind B950, 
+If you're curious about the reasoning behind B950,
 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
 explains it.  The tl;dr is "it's like highway speed limits, we won't
 bother you if you overdo it by a few km/h".
 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
 explains it.  The tl;dr is "it's like highway speed limits, we won't
 bother you if you overdo it by a few km/h".
@@ -682,7 +682,7 @@ $ where black
 
 
 
 
 
 
-### Wing IDE 
+### Wing IDE
 
 Wing supports black via the OS Commands tool, as explained in the Wing documentation on [pep8 formatting](https://wingware.com/doc/edit/pep8). The detailed procedure is:
 
 
 Wing supports black via the OS Commands tool, as explained in the Wing documentation on [pep8 formatting](https://wingware.com/doc/edit/pep8). The detailed procedure is:
 
@@ -704,7 +704,7 @@ $ black --help
 - click on **+** in **OS Commands** -> New: Command line..
   - Title: black
   - Command Line: black %s
 - click on **+** in **OS Commands** -> New: Command line..
   - Title: black
   - Command Line: black %s
-  - I/O Encoding: Use Default 
+  - I/O Encoding: Use Default
   - Key Binding: F1
   - [x] Raise OS Commands when executed
   - [x] Auto-save files before execution
   - Key Binding: F1
   - [x] Raise OS Commands when executed
   - [x] Auto-save files before execution
@@ -730,16 +730,22 @@ Configuration:
 To install with [vim-plug](https://github.com/junegunn/vim-plug):
 
 ```
 To install with [vim-plug](https://github.com/junegunn/vim-plug):
 
 ```
-Plug 'python/black'
+Plug 'psf/black'
 ```
 
 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
 
 ```
 ```
 
 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
 
 ```
-Plugin 'python/black'
+Plugin 'psf/black'
 ```
 
 or you can copy the plugin from [plugin/black.vim](https://github.com/psf/black/tree/master/plugin/black.vim).
 ```
 
 or you can copy the plugin from [plugin/black.vim](https://github.com/psf/black/tree/master/plugin/black.vim).
+
+```
+mkdir -p ~/.vim/pack/python/start/black/plugin
+curl https://raw.githubusercontent.com/psf/black/master/plugin/black.vim -o ~/.vim/pack/python/start/black/plugin/black.vim
+```
+
 Let me know if this requires any changes to work with Vim 8's builtin
 `packadd`, or Pathogen, and so on.
 
 Let me know if this requires any changes to work with Vim 8's builtin
 `packadd`, or Pathogen, and so on.
 
@@ -762,6 +768,12 @@ To run *Black* on save, add the following line to `.vimrc` or `init.vim`:
 autocmd BufWritePre *.py execute ':Black'
 ```
 
 autocmd BufWritePre *.py execute ':Black'
 ```
 
+To run *Black* on a key press (e.g. F9 below), add this:
+
+```
+nnoremap <F9> :Black<CR>
+```
+
 **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`.
 **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`.
@@ -798,6 +810,14 @@ the [Python Language Server](https://github.com/palantir/python-language-server)
 
 Use [python-black](https://atom.io/packages/python-black).
 
 
 Use [python-black](https://atom.io/packages/python-black).
 
+### Kakoune 
+
+Add the following hook to your kakrc, then run black with `:format`.
+```
+hook global WinSetOption filetype=python %{
+    set-option window formatcmd 'black -q  -'
+}
+``` 
 
 ### Other editors
 
 
 ### Other editors
 
@@ -893,6 +913,9 @@ Apart from the above, `blackd` can produce the following response codes:
  - `HTTP 500`: If there was any kind of error while trying to format the input.
        The response body contains a textual representation of the error.
 
  - `HTTP 500`: If there was any kind of error while trying to format the input.
        The response body contains a textual representation of the error.
 
+The response headers include a `X-Black-Version` header containing the version
+of *Black*.
+
 ## Version control integration
 
 Use [pre-commit](https://pre-commit.com/). Once you [have it
 ## Version control integration
 
 Use [pre-commit](https://pre-commit.com/). Once you [have it
@@ -943,7 +966,7 @@ write the above files to `.cache/black/<version>/`.
 The following notable open-source projects trust *Black* with enforcing
 a consistent code style: pytest, tox, Pyramid, Django Channels, Hypothesis,
 attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Pipenv, virtualenv),
 The following notable open-source projects trust *Black* with enforcing
 a consistent code style: pytest, tox, Pyramid, Django Channels, Hypothesis,
 attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Pipenv, virtualenv),
-every Datadog Agent Integration.
+pandas, Pillow, every Datadog Agent Integration.
 
 Are we missing anyone?  Let us know.
 
 
 Are we missing anyone?  Let us know.
 
@@ -1045,6 +1068,14 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 * if *Black* puts parenthesis around a single expression, it moves comments
   to the wrapped expression instead of after the brackets (#872)
 
 * if *Black* puts parenthesis around a single expression, it moves comments
   to the wrapped expression instead of after the brackets (#872)
 
+* *Black* is now able to format Python code that uses assignment expressions
+  (`:=` as described in PEP-572) (#935)
+
+* *Black* is now able to format Python code that uses positional-only
+  arguments (`/` as described in PEP-570) (#946)
+
+* `blackd` now returns the version of *Black* in the response headers (#1013)
+
 
 ### 19.3b0
 
 
 ### 19.3b0