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

a9d33d2d85307cb89cabb4d05043b5b045ebdc71
[etc/vim.git] / docs / integrations / source_version_control.md
1 # Version control integration
2
3 Use [pre-commit](https://pre-commit.com/). Once you
4 [have it installed](https://pre-commit.com/#install), add this to the
5 `.pre-commit-config.yaml` in your repository:
6
7 ```yaml
8 repos:
9   - repo: https://github.com/psf/black
10     rev: 23.7.0
11     hooks:
12       - id: black
13         # It is recommended to specify the latest version of Python
14         # supported by your project here, or alternatively use
15         # pre-commit's default_language_version, see
16         # https://pre-commit.com/#top_level-default_language_version
17         language_version: python3.11
18 ```
19
20 Feel free to switch out the `rev` value to something else, like another
21 [tag/version][black-tags] or even a specific commit. Although we discourage the use of
22 branches or other mutable refs since the hook [won't auto update as you may
23 expect][pre-commit-mutable-rev].
24
25 ## Jupyter Notebooks
26
27 There is an alternate hook `black-jupyter` that expands the targets of `black` to
28 include Jupyter Notebooks. To use this hook, simply replace the hook's `id: black` with
29 `id: black-jupyter` in the `.pre-commit-config.yaml`:
30
31 ```yaml
32 repos:
33   - repo: https://github.com/psf/black
34     rev: 23.7.0
35     hooks:
36       - id: black-jupyter
37         # It is recommended to specify the latest version of Python
38         # supported by your project here, or alternatively use
39         # pre-commit's default_language_version, see
40         # https://pre-commit.com/#top_level-default_language_version
41         language_version: python3.11
42 ```
43
44 ```{note}
45 The `black-jupyter` hook became available in version 21.8b0.
46 ```
47
48 [black-tags]: https://github.com/psf/black/tags
49 [pre-commit-mutable-rev]:
50   https://pre-commit.com/#using-the-latest-version-for-a-repository