X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/911470a610e47d9da5ea938b0887c3df62819b85..b2f03f913282b359d6301c426093b59b04303cff:/docs/integrations/source_version_control.md diff --git a/docs/integrations/source_version_control.md b/docs/integrations/source_version_control.md index b07796f..2afcc02 100644 --- a/docs/integrations/source_version_control.md +++ b/docs/integrations/source_version_control.md @@ -6,22 +6,48 @@ Use [pre-commit](https://pre-commit.com/). Once you ```yaml repos: - - repo: https://github.com/psf/black - rev: 21.9b0 + # Using this mirror lets us use mypyc-compiled black, which is about 2x faster + - repo: https://github.com/psf/black-pre-commit-mirror + rev: 23.9.1 hooks: - id: black - language_version: python3 # Should be a command that runs python3.6+ + # It is recommended to specify the latest version of Python + # supported by your project here, or alternatively use + # pre-commit's default_language_version, see + # https://pre-commit.com/#top_level-default_language_version + language_version: python3.11 ``` -Feel free to switch out the `rev` value to something else, like another -[tag/version][black-tags] or even a specific commit. Although we discourage the use of +Feel free to switch out the `rev` value to a different version of Black. + +Note if you'd like to use a specific commit in `rev`, you'll need to swap the repo +specified from the mirror to https://github.com/psf/black. We discourage the use of branches or other mutable refs since the hook [won't auto update as you may expect][pre-commit-mutable-rev]. -If you want support for Jupyter Notebooks as well, then replace `id: black` with -`id: black-jupyter` (though note that it's only available from version `21.8b0` -onwards). +## Jupyter Notebooks + +There is an alternate hook `black-jupyter` that expands the targets of `black` to +include Jupyter Notebooks. To use this hook, simply replace the hook's `id: black` with +`id: black-jupyter` in the `.pre-commit-config.yaml`: + +```yaml +repos: + # Using this mirror lets us use mypyc-compiled black, which is about 2x faster + - repo: https://github.com/psf/black-pre-commit-mirror + rev: 23.9.1 + hooks: + - id: black-jupyter + # It is recommended to specify the latest version of Python + # supported by your project here, or alternatively use + # pre-commit's default_language_version, see + # https://pre-commit.com/#top_level-default_language_version + language_version: python3.11 +``` + +```{note} +The `black-jupyter` hook became available in version 21.8b0. +``` -[black-tags]: https://github.com/psf/black/tags [pre-commit-mutable-rev]: https://pre-commit.com/#using-the-latest-version-for-a-repository