]> git.madduck.net Git - etc/vim.git/blob - docs/version_control_integration.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:

Only require typing-extensions if Python < 3.8 (#1873)
[etc/vim.git] / docs / version_control_integration.md
1 [//]: # "NOTE: THIS FILE WAS AUTOGENERATED FROM README.md"
2
3 # Version control integration
4
5 Use [pre-commit](https://pre-commit.com/). Once you
6 [have it installed](https://pre-commit.com/#install), add this to the
7 `.pre-commit-config.yaml` in your repository:
8
9 ```yaml
10 repos:
11   - repo: https://github.com/psf/black
12     rev: 20.8b1 # Replace by any tag/version: https://github.com/psf/black/tags
13     hooks:
14       - id: black
15         language_version: python3 # Should be a command that runs python3.6+
16 ```
17
18 Then run `pre-commit install` and you're ready to go.
19
20 Avoid using `args` in the hook. Instead, store necessary configuration in
21 `pyproject.toml` so that editors and command-line usage of Black all behave consistently
22 for your project. See _Black_'s own
23 [pyproject.toml](https://github.com/psf/black/blob/master/pyproject.toml) for an
24 example.
25
26 When using the `--diff` flag with `pre-commit`, you must also use the `--check` flag.
27 When you want to run _Black_ only on specific files in pre-commit, either use
28 pre-commit's own `files` and `exclude` or, when using _Black_'s `--include`, set
29 `--force-exclude` to the negated regex of `--include`.
30
31 If you're already using Python 3.7, switch the `language_version` accordingly. Finally,
32 `stable` is a branch that tracks the latest release on PyPI. If you'd rather run on
33 master, this is also an option.