X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0f99987c0a90efa26667dea3df73b1643a84f07b..2e0bb0fa9f9fffedecaa1f088f313f6c2d6df965:/README.md diff --git a/README.md b/README.md index 87da205..be0577c 100644 --- a/README.md +++ b/README.md @@ -357,6 +357,28 @@ affect your use case. This can be used for example with PyCharm's [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html). +## Version control integration + +Use [pre-commit](https://pre-commit.com/). Once you [have it +installed](https://pre-commit.com/#install), add this to the +`.pre-commit-config.yaml` in your repository: +```yaml +repos: +- repo: https://github.com/ambv/black + rev: stable + hooks: + - id: black + args: [--line-length=88, --safe] + python_version: python3.6 +``` +Then run `pre-commit install` and you're ready to go. + +`args` in the above config is optional but shows you how you can change +the line length if you really need to. If you're already using Python +3.7, switch the `python_version` accordingly. Finally, `stable` is a tag +that is pinned to the latest release on PyPI. If you'd rather run on +master, this is also an option. + ## Testimonials **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips): @@ -416,8 +438,12 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * added `--quiet` (#78) +* added [pre-commit](https://pre-commit.com) integration (#103, #104) + * fixed reporting on `--check` with multiple files (#101, #102) +* fixed removing backslash escapes from raw strings (#100, #105) + ### 18.4a0 * added `--diff` (#87) @@ -546,6 +572,7 @@ Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com) and [Carl Meyer](mailto:carl@oddbird.net). Multiple contributions by: +* [Anthony Sottile](mailto:asottile@umich.edu) * [Artem Malyshev](mailto:proofit404@gmail.com) * [Daniel M. Capella](mailto:polycitizen@gmail.com) * [Eli Treuherz](mailto:eli.treuherz@cgi.com)