X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/bc36e95966d5bbdd7621cdb8f2d8effcd4818bf6..65ea568e3301951f26e0e3b98f6d5dc80132e917:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 9c83f26..0d535d9 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -![Black Logo](https://raw.githubusercontent.com/python/black/master/docs/_static/logo2-readme.png) +![Black Logo](https://raw.githubusercontent.com/psf/black/master/docs/_static/logo2-readme.png)

The Uncompromising Code Formatter

-Build Status +Build Status Documentation Status -Coverage Status -License: MIT +Coverage Status +License: MIT PyPI Downloads -Code style: black +Code style: black

> “Any color you like.” @@ -293,7 +293,7 @@ you are probably already using. You'd do it like this: max-line-length = 80 ... select = C,E,F,W,B,B950 -ignore = E501 +ignore = E501,W503,E203 ``` You'll find *Black*'s own .flake8 config file is configured like this. @@ -373,7 +373,7 @@ The main reason to standardize on a single form of quotes is aesthetics. Having one kind of quotes everywhere reduces reader distraction. It will also enable a future version of *Black* to merge consecutive string literals that ended up on the same line (see -[#26](https://github.com/python/black/issues/26) for details). +[#26](https://github.com/psf/black/issues/26) for details). Why settle on double quotes? They anticipate apostrophes in English text. They match the docstring standard described in [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). @@ -730,16 +730,16 @@ Configuration: 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): ``` -Plugin 'python/black' +Plugin 'psf/black' ``` -or you can copy the plugin from [plugin/black.vim](https://github.com/python/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). Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or Pathogen, and so on. @@ -844,6 +844,14 @@ Options: -h, --help Show this message and exit. ``` +There is no official blackd client tool (yet!). You can test that blackd is +working using `curl`: + +``` +blackd --bind-port 9090 & # or let blackd choose a port +curl -s -XPOST "localhost:9090" -d "print('valid')" +``` + ### Protocol `blackd` only accepts `POST` requests at the `/` path. The body of the request @@ -892,7 +900,7 @@ installed](https://pre-commit.com/#install), add this to the `.pre-commit-config.yaml` in your repository: ```yaml repos: -- repo: https://github.com/python/black +- repo: https://github.com/psf/black rev: stable hooks: - id: black @@ -902,7 +910,7 @@ Then run `pre-commit install` and you're ready to go. Avoid using `args` in the hook. Instead, store necessary configuration in `pyproject.toml` so that editors and command-line usage of Black all -behave consistently for your project. See *Black*'s own `pyproject.toml` +behave consistently for your project. See *Black*'s own [pyproject.toml](/pyproject.toml) for an example. If you're already using Python 3.7, switch the `language_version` @@ -925,12 +933,17 @@ is: `file-mode` is an int flag that determines whether the file was formatted as 3.6+ only, as .pyi, and whether string normalization was omitted. +To override the location of these files on macOS or Linux, set the environment variable +`XDG_CACHE_HOME` to your preferred location. For example, if you want to put the cache in +the directory you're running *Black* from, set `XDG_CACHE_HOME=.cache`. *Black* will then +write the above files to `.cache/black//`. ## Used by 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). +attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Pipenv, virtualenv), +every Datadog Agent Integration. Are we missing anyone? Let us know. @@ -961,16 +974,16 @@ and [`pipenv`](https://docs.pipenv.org/): Use the badge in your project's README.md: ```markdown -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) ``` Using the badge in README.rst: ``` .. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/python/black + :target: https://github.com/psf/black ``` -Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) +Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) ## License @@ -996,31 +1009,48 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log -### 19.5b0 +### unreleased -* don't crash when run on a Windows machine with more than 61 cores (#838) +* added `black -c` as a way to format code passed from the command line + (#761) -* remove unnecessary parentheses around `yield` expressions (#834) +* --safe now works with Python 2 code (#840) -* add parentheses around long tuples in unpacking assignments (#832) +* fixed grammar selection for Python 2-specific code (#765) -* don't produce invalid code for `from` ... `import` blocks with comments +* fixed feature detection for trailing commas in function definitions + and call sites (#763) + +* *Black* can now format async generators (#593) + +* *Black* no longer crashes on Windows machines with more than 61 cores + (#838) + +* *Black* no longer crashes on standalone comments prepended with + a backslash (#767) + +* *Black* no longer crashes on `from` ... `import` blocks with comments (#829) -* fix grammar selection (#765) +* removed unnecessary parentheses around `yield` expressions (#834) -* fix feature detection for trailing commas in function definitions and - call sites (#763) +* added parentheses around long tuples in unpacking assignments (#832) -* add `black -c` as a way to format code passed from the command line (#761) +* fixed bug that led *Black* format some code with a line length target + of 1 (#762) -* fix bug that led *Black* format some code with a line length target of 1 - (#762) +* *Black* no longer introduces quotes in f-string subexpressions on string + boundaries (#863) -* --safe now works with Python 2 code (#840) +* 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) -* *Black* no longer crashes on standalone comments prepended with - a backslash (#767) ### 19.3b0 @@ -1048,6 +1078,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * `blackd` now supports CORS (#622) + ### 18.9b0 * numeric literals are now formatted by *Black* (#452, #461, #464, #469):