]>
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:
-
+
<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/python/black"><img alt="Build Status" src="https://travis-ci.org/python /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://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/python/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/python /black/badge.svg?branch=master"></a>
-<a href="https://github.com/p
ython /black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></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/p
sf /black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
<a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://black.readthedocs.io/en/stable/_static/pypi.svg"></a>
<a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
<a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://black.readthedocs.io/en/stable/_static/pypi.svg"></a>
<a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
-<a href="https://github.com/p
ython /black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+<a href="https://github.com/p
sf /black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
</p>
> “Any color you like.”
</p>
> “Any color you like.”
max-line-length = 80
...
select = C,E,F,W,B,B950
max-line-length = 80
...
select = C,E,F,W,B,B950
```
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.
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
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).
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).
To install with [vim-plug](https://github.com/junegunn/vim-plug):
```
To install with [vim-plug](https://github.com/junegunn/vim-plug):
```
```
or with [Vundle](https://github.com/VundleVim/Vundle.vim):
```
```
or with [Vundle](https://github.com/VundleVim/Vundle.vim):
```
-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.
Let me know if this requires any changes to work with Vim 8's builtin
`packadd`, or Pathogen, and so on.
-h, --help Show this message and exit.
```
-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
### Protocol
`blackd` only accepts `POST` requests at the `/` path. The body of the request
`.pre-commit-config.yaml` in your repository:
```yaml
repos:
`.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
rev: stable
hooks:
- id: black
Avoid using `args` in the hook. Instead, store necessary configuration
in `pyproject.toml` so that editors and command-line usage of Black all
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`
for an example.
If you're already using Python 3.7, switch the `language_version`
`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.
`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/<version>/`.
## Used by
The following notable open-source projects trust *Black* with enforcing
a consistent code style: pytest, tox, Pyramid, Django Channels, Hypothesis,
## 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.
Are we missing anyone? Let us know.
Use the badge in your project's README.md:
```markdown
Use the badge in your project's README.md:
```markdown
-[](https://github.com/python /black)
+[](https://github.com/psf /black)
```
Using the badge in README.rst:
```
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
```
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: [](https://github.com/python /black)
+Looks like this: [](https://github.com/psf /black)
* added `black -c` as a way to format code passed from the command line
(#761)
* added `black -c` as a way to format code passed from the command line
(#761)
* fixed feature detection for trailing commas in function definitions
and call sites (#763)
* 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 Windows machines with more than 61 cores
(#838)
* fixed bug that led *Black* format some code with a line length target
of 1 (#762)
* fixed 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)
+
+* 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)
+
projects / etc / vim.git / blobdiff