X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/af8fd24068098331c7d5333e00d1511b157e94f0..3fb451687293c993b10d860449eb405ddd44f377:/README.md diff --git a/README.md b/README.md index 0d0c788..d6fbf09 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ content instead. *Black* makes code review faster by producing the smallest diffs possible. +Try it out now using the [Black Playground](https://black.now.sh). + --- *Contents:* **[Installation and usage](#installation-and-usage)** | @@ -617,17 +619,28 @@ $ where black - Name: Black - Description: Black is the uncompromising Python code formatter. - Program: - - Arguments: $FilePath$ + - Arguments: `$FilePath$` 5. Format the currently opened file by selecting `Tools -> External Tools -> black`. - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`. +6. Optionally, run Black on every file save: + + 1. Make sure you have the [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin installed. + 2. Go to `Preferences -> Tools -> File Watchers` and click `+` to add a new watcher: + - Name: Black + - File type: Python + - Scope: Project Files + - Program: + - Arguments: `$FilePath$` + - Output paths to refresh: `$FilePathRelativeToProjectRoot$` + - Working directory: `$ProjectFileDir$` ### Vim Commands and shortcuts: -* `,=` or `:Black` to format the entire file (ranges not supported); +* `:Black` to format the entire file (ranges not supported); * `:BlackUpgrade` to upgrade *Black* inside the virtualenv; * `:BlackVersion` to get the current version of *Black* inside the virtualenv. @@ -670,7 +683,7 @@ The plugin will use it. To run *Black* on save, add the following line to `.vimrc` or `init.vim`: ``` -autocmd BufWritePost *.py execute ':Black' +autocmd BufWritePre *.py execute ':Black' ``` **How to get Vim with Python 3.6?** @@ -697,10 +710,22 @@ Use [sublack plugin](https://github.com/jgirardet/sublack). Use [blackcellmagic](https://github.com/csurfer/blackcellmagic). +### Python Language Server + +If your editor supports the [Language Server Protocol](https://langserver.org/) +(Atom, Sublime Text, Visual Studio Code and many more), you can use +the [Python Language Server](https://github.com/palantir/python-language-server) with the +[pyls-black](https://github.com/rupert/pyls-black) plugin. + + +### Atom/Nuclide + +Use [atom-black](https://github.com/hauntsaninja/atom-black). + + ### Other editors -Atom/Nuclide integration is planned by the author, others will -require external contributions. +Other editors will require external contributions. Patches welcome! ✨ 🍰 ✨ @@ -784,7 +809,7 @@ Using the badge in README.rst: ``` .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black -``` +``` Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) @@ -812,8 +837,33 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log +### 18.8b0 + +* fix parsing of `__future__` imports with renames (#389) +* fix scope of `# fmt: off` when directly preceding `yield` and other nodes (#385) + +### 18.6b4 + +* hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371) + + ### 18.6b3 +* typing stub files (`.pyi`) now have blank lines added after constants (#340) + +* `# fmt: off` and `# fmt: on` are now much more dependable: + + * they now work also within bracket pairs (#329) + + * they now correctly work across function/class boundaries (#335) + + * they now work when an indentation block starts with empty lines or misaligned + comments (#334) + +* made Click not fail on invalid environments; note that Click is right but the + likelihood we'll need to access non-ASCII file paths when dealing with Python source + code is low (#277) + * fixed improper formatting of f-strings with quotes inside interpolated expressions (#322) @@ -823,6 +873,8 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * fixed cannibalizing backslashes during string normalization +* fixed a crash due to symbolic links pointing outside of the project directory (#338) + ### 18.6b2 @@ -1157,6 +1209,7 @@ Multiple contributions by: * [Jonas Obrist](mailto:ojiidotch@gmail.com) * [Luka Sterbic](mailto:luka.sterbic@gmail.com) * [Miguel Gaiowski](mailto:miggaiowski@gmail.com) +* [Neraste](neraste.herr10@gmail.com) * [Osaetin Daniel](mailto:osaetindaniel@gmail.com) * [Peter Bengtsson](mailto:mail@peterbe.com) * [Stavros Korokithakis](mailto:hi@stavros.io)