CINXE.COM

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> <link rel="stylesheet" href="build/main_bs5.css"> <title>pre-commit</title> </head> <body data-bs-spy="scroll" data-bs-target="#content-navigation"> <nav class="navbar navbar-expand-md navbar-dark bg-primary"> <div class="container-md"> <a class="navbar-brand" href="/"> <img src="logo.svg" width="55" height="55" alt="" loading="lazy"> </a> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" > </button> <div class="collapse navbar-collapse" id="navbar"> <ul class="navbar-nav"> <li class="nav-item"> <a class="nav-link active" href="index.html">Documentation</a> </li> <li class="nav-item"> <a class="nav-link" href="hooks.html">Supported hooks</a> </li> <li class="nav-item"> <a class="nav-link" href="https://github.com/pre-commit/demo-repo#readme">Demo</a> </li> </ul> <ul class="navbar-nav ms-auto"> <li class="nav-item"> <a href="https://github.com/pre-commit/pre-commit" role="button" class="btn btn-outline-info my-2 my-sm-0">Download on GitHub</a> </li> </ul> </div> </div> </nav> <header class="bg-light"> <div class="container-md py-4 py-lg-0"> <div class="d-flex justify-content-between align-items-center"> <div> <h1 class="display-5 pb-3 text-secondary fw-bold">pre-commit</h1> A framework for managing and maintaining multi-language pre-commit hooks. <div class="mb-3"> <a href="https://github.com/pre-commit/pre-commit/actions/workflows/main.yml"> <img src="https://github.com/pre-commit/pre-commit/actions/workflows/main.yml/badge.svg" alt="build status" style="max-width:100%;"> </a> <a href="https://results.pre-commit.ci/latest/github/pre-commit/pre-commit/main"> <img src="https://results.pre-commit.ci/badge/github/pre-commit/pre-commit/main.svg" alt="pre-commit.ci status" style="max-width:100%;"> </a> </div> <div> <a class="github-button" href="https://github.com/pre-commit/pre-commit" data-show-count="true" aria-label="Star pre-commit/pre-commit on GitHub">Star</a> <script async defer src="https://buttons.github.io/buttons.js"></script> </div> </div> <img src="logo-top-shelf.png" alt="pre-commit logo" class="d-none d-lg-block" /> </div> </div> </header> <main class="container-md my-4"> <div class="row"> <div class="col-sm-3 d-none d-lg-block"> <nav class="nav flex-column nav-pills sticky-top" aria-orientation="vertical" id="content-navigation"> <a class="nav-link active" href="#intro" role="tab">Introduction</a> <a class="nav-link" href="#install" role="tab">Installation</a> <a class="nav-link" href="#plugins" role="tab">Adding plugins</a> <a class="nav-link" href="#usage" role="tab">Usage</a> <a class="nav-link" href="#new-hooks" role="tab">Creating new hooks</a> <a class="nav-link" href="#cli" role="tab">Command line interface</a> <a class="nav-link" href="#advanced" role="tab">Advanced features</a> <a class="nav-link" href="#contributing" role="tab">Contributing</a> </nav> </div> <div class="col-lg-9 col-12"> <div id="intro"> <div class="page-header"><h1 id="introduction"> Introduction <a href="#introduction" class="text-decoration-none">¶</a></h1> </div> Git hook scripts are useful for identifying simple issues before submission to code review. We run our hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements. By pointing these issues out before code review, this allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks. As we created more libraries and projects we recognized that sharing our pre-commit hooks across projects is painful. We copied and pasted unwieldy bash scripts from project to project and had to manually change the hooks to work for different project structures. We believe that you should always use the best industry standard linters. Some of the best linters are written in languages that you do not use in your project or have installed on your machine. For example scss-lint is a linter for SCSS written in Ruby. If you’re writing a project in node you should be able to use scss-lint as a pre-commit hook without adding a Gemfile to your project or understanding how to get scss-lint installed. We built pre-commit to solve our hook issues. It is a multi-language package manager for pre-commit hooks. You specify a list of hooks you want and pre-commit manages the installation and execution of any hook written in any language before every commit. pre-commit is specifically designed to not require root access. If one of your developers doesn’t have node installed but modifies a JavaScript file, pre-commit automatically handles downloading and building node to run eslint without root. </div> <div id="install"> <div class="page-header"><h1 id="installation"> Installation <a href="#installation" class="text-decoration-none">¶</a></h1> </div> Before you can run hooks, you need to have the pre-commit package manager installed. Using pip: <div class="highlight bash"><pre>pip install pre-commit </pre></div> In a python project, add the following to your requirements.txt (or requirements-dev.txt): <div class="highlight"><pre>pre-commit </pre></div> As a 0-dependency <a href="https://docs.python.org/3/library/zipapp.html">zipapp</a>: <ul> <li>locate and download the <code>.pyz</code> file from the <a href="https://github.com/pre-commit/pre-commit/releases">github releases</a></li> <li>run <code>python pre-commit-#.#.#.pyz ...</code> in place of <code>pre-commit ...</code></li> </ul> <h2 id="quick-start"> Quick start <a href="#quick-start" class="text-decoration-none">¶</a></h2> <h3 id="1-install-pre-commit"> 1. Install pre-commit <a href="#1-install-pre-commit" class="text-decoration-none">¶</a></h3> <ul> <li>follow the <a href="#install">install</a> instructions above</li> <li><code>pre-commit --version</code> should show you what version you're using</li> </ul> <div class="highlight pre-commit"><pre>$ pre-commit --version pre-commit 4.0.1 </pre></div> <h3 id="2-add-a-pre-commit-configuration"> 2. Add a pre-commit configuration <a href="#2-add-a-pre-commit-configuration" class="text-decoration-none">¶</a></h3> <ul> <li>create a file named <code>.pre-commit-config.yaml</code></li> <li>you can generate a very basic configuration using <a href="#pre-commit-sample-config"><code>pre-commit sample-config</code></a></li> <li>the full set of options for the configuration are listed <a href="#plugins">below</a></li> <li>this example uses a formatter for python code, however <code>pre-commit</code> works for any programming language</li> <li>other <a href="hooks.html">supported hooks</a> are available</li> </ul> <div class="highlight yaml"><pre>repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.3.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/psf/black rev: 22.10.0 hooks: - id: black </pre></div> <h3 id="3-install-the-git-hook-scripts"> 3. Install the git hook scripts <a href="#3-install-the-git-hook-scripts" class="text-decoration-none">¶</a></h3> <ul> <li>run <code>pre-commit install</code> to set up the git hook scripts</li> </ul> <div class="highlight console"><pre>$ pre-commit install pre-commit installed at .git/hooks/pre-commit </pre></div> <ul> <li>now <code>pre-commit</code> will run automatically on <code>git commit</code>!</li> </ul> <h3 id="4-optional-run-against-all-the-files"> 4. (optional) Run against all the files <a href="#4-optional-run-against-all-the-files" class="text-decoration-none">¶</a></h3> <ul> <li>it's usually a good idea to run the hooks against all of the files when adding new hooks (usually <code>pre-commit</code> will only run on the changed files during git hooks)</li> </ul> <div class="highlight pre-commit"><pre>$ pre-commit run --all-files [INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Initializing environment for https://github.com/psf/black. [INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... [INFO] Installing environment for https://github.com/psf/black. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... Check Yaml...............................................................Passed Fix End of Files.........................................................Passed Trim Trailing Whitespace.................................................Failed - hook id: trailing-whitespace - exit code: 1 Files were modified by this hook. Additional output: Fixing sample.py black....................................................................Passed </pre></div> <ul> <li>oops! looks like I had some trailing whitespace</li> <li>consider running that in <a href="#usage-in-continuous-integration">CI</a> too</li> </ul> </div> <div id="plugins"> <div class="page-header"><h1 id="adding-pre-commit-plugins-to-your-project"> Adding pre-commit plugins to your project <a href="#adding-pre-commit-plugins-to-your-project" class="text-decoration-none">¶</a></h1> </div> Once you have pre-commit installed, adding pre-commit plugins to your project is done with the <code>.pre-commit-config.yaml</code> configuration file. Add a file called <code>.pre-commit-config.yaml</code> to the root of your project. The pre-commit config file describes what repositories and hooks are installed. <h2 id="pre-commit-configyaml---top-level"> .pre-commit-config.yaml - top level <a href="#pre-commit-configyaml---top-level" class="text-decoration-none">¶</a></h2> <table class="table table-bordered"><tbody><tr><td><a id="top_level-repos" href="#top_level-repos"><code>repos</code></a> </td><td>A list of <a href="#pre-commit-configyaml---repos">repository mappings</a>. </td></tr><tr><td><a id="top_level-default_install_hook_types" href="#top_level-default_install_hook_types"><code>default_install_hook_types</code></a> </td><td>(optional: default <code>[pre-commit]</code>) a list of <code>--hook-type</code>s which will be used by default when running <a href="#pre-commit-install"><code>pre-commit install</code></a>. </td></tr><tr><td><a id="top_level-default_language_version" href="#top_level-default_language_version"><code>default_language_version</code></a> </td><td>(optional: default <code>{}</code>) a mapping from language to the default <a href="#config-language_version"><code>language_version</code></a> that should be used for that language. This will only override individual hooks that do not set <a href="#config-language_version"><code>language_version</code></a>. For example to use <code>python3.7</code> for <code>language: python</code> hooks: <div class="highlight yaml"><pre>default_language_version: python: python3.7 </pre></div> </td></tr><tr><td><a id="top_level-default_stages" href="#top_level-default_stages"><code>default_stages</code></a> </td><td>(optional: default (all stages)) a configuration-wide default for the <a href="#config-stages"><code>stages</code></a> property of hooks. This will only override individual hooks that do not set <a href="#config-stages"><code>stages</code></a>. For example: <div class="highlight yaml"><pre>default_stages: [pre-commit, pre-push] </pre></div> </td></tr><tr><td><a id="top_level-files" href="#top_level-files"><code>files</code></a> </td><td>(optional: default <code>''</code>) global file include pattern. </td></tr><tr><td><a id="top_level-exclude" href="#top_level-exclude"><code>exclude</code></a> </td><td>(optional: default <code>^$</code>) global file exclude pattern. </td></tr><tr><td><a id="top_level-fail_fast" href="#top_level-fail_fast"><code>fail_fast</code></a> </td><td>(optional: default <code>false</code>) set to <code>true</code> to have pre-commit stop running hooks after the first failure. </td></tr><tr><td><a id="top_level-minimum_pre_commit_version" href="#top_level-minimum_pre_commit_version"><code>minimum_pre_commit_version</code></a> </td><td>(optional: default <code>'0'</code>) require a minimum version of pre-commit. </td></tr></tbody></table>A sample top-level: <div class="highlight yaml"><pre>exclude: '^$' fail_fast: false repos: - ... </pre></div> <h2 id="pre-commit-configyaml---repos"> .pre-commit-config.yaml - repos <a href="#pre-commit-configyaml---repos" class="text-decoration-none">¶</a></h2> The repository mapping tells pre-commit where to get the code for the hook from. <table class="table table-bordered"><tbody><tr><td><a id="repos-repo" href="#repos-repo"><code>repo</code></a> </td><td>the repository url to <code>git clone</code> from or one of the special sentinel values: <a href="#repository-local-hooks"><code>local</code></a>, <a href="#meta-hooks"><code>meta</code></a>. </td></tr><tr><td><a id="repos-rev" href="#repos-rev"><code>rev</code></a> </td><td>the revision or tag to clone at. </td></tr><tr><td><a id="repos-hooks" href="#repos-hooks"><code>hooks</code></a> </td><td>A list of <a href="#pre-commit-configyaml---hooks">hook mappings</a>. </td></tr></tbody></table>A sample repository: <div class="highlight yaml"><pre>repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v1.2.3 hooks: - ... </pre></div> <h2 id="pre-commit-configyaml---hooks"> .pre-commit-config.yaml - hooks <a href="#pre-commit-configyaml---hooks" class="text-decoration-none">¶</a></h2> The hook mapping configures which hook from the repository is used and allows for customization. All optional keys will receive their default from the repository's configuration. <table class="table table-bordered"><tbody><tr><td><a id="config-id" href="#config-id"><code>id</code></a> </td><td>which hook from the repository to use. </td></tr><tr><td><a id="config-alias" href="#config-alias"><code>alias</code></a> </td><td>(optional) allows the hook to be referenced using an additional id when using <code>pre-commit run <hookid></code>. </td></tr><tr><td><a id="config-name" href="#config-name"><code>name</code></a> </td><td>(optional) override the name of the hook - shown during hook execution. </td></tr><tr><td><a id="config-language_version" href="#config-language_version"><code>language_version</code></a> </td><td>(optional) override the language version for the hook. See <a href="#overriding-language-version">Overriding Language Version</a>. </td></tr><tr><td><a id="config-files" href="#config-files"><code>files</code></a> </td><td>(optional) override the default pattern for files to run on. </td></tr><tr><td><a id="config-exclude" href="#config-exclude"><code>exclude</code></a> </td><td>(optional) file exclude pattern. </td></tr><tr><td><a id="config-types" href="#config-types"><code>types</code></a> </td><td>(optional) override the default file types to run on (AND). See <a href="#filtering-files-with-types">Filtering files with types</a>. </td></tr><tr><td><a id="config-types_or" href="#config-types_or"><code>types_or</code></a> </td><td>(optional) override the default file types to run on (OR). See <a href="#filtering-files-with-types">Filtering files with types</a>. </td></tr><tr><td><a id="config-exclude_types" href="#config-exclude_types"><code>exclude_types</code></a> </td><td>(optional) file types to exclude. </td></tr><tr><td><a id="config-args" href="#config-args"><code>args</code></a> </td><td>(optional) list of additional parameters to pass to the hook. </td></tr><tr><td><a id="config-stages" href="#config-stages"><code>stages</code></a> </td><td>(optional) selects which git hook(s) to run for. See <a href="#confining-hooks-to-run-at-certain-stages">Confining hooks to run at certain stages</a>. </td></tr><tr><td><a id="config-additional_dependencies" href="#config-additional_dependencies"><code>additional_dependencies</code></a> </td><td>(optional) a list of dependencies that will be installed in the environment where this hook gets run. One useful application is to install plugins for hooks such as <code>eslint</code>. </td></tr><tr><td><a id="config-always_run" href="#config-always_run"><code>always_run</code></a> </td><td>(optional) if <code>true</code>, this hook will run even if there are no matching files. </td></tr><tr><td><a id="config-verbose" href="#config-verbose"><code>verbose</code></a> </td><td>(optional) if <code>true</code>, forces the output of the hook to be printed even when the hook passes. </td></tr><tr><td><a id="config-log_file" href="#config-log_file"><code>log_file</code></a> </td><td>(optional) if present, the hook output will additionally be written to a file when the hook fails or <a href="#config-verbose">verbose</a> is <code>true</code>. </td></tr></tbody></table>One example of a complete configuration: <div class="highlight yaml"><pre>repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v1.2.3 hooks: - id: trailing-whitespace </pre></div> This configuration says to download the pre-commit-hooks project and run its trailing-whitespace hook. <h2 id="updating-hooks-automatically"> Updating hooks automatically <a href="#updating-hooks-automatically" class="text-decoration-none">¶</a></h2> You can update your hooks to the latest version automatically by running <a href="#pre-commit-autoupdate"><code>pre-commit autoupdate</code></a>. By default, this will bring the hooks to the latest tag on the default branch. </div> <div id="usage"> <div class="page-header"><h1 id="usage"> Usage <a href="#usage" class="text-decoration-none">¶</a></h1> </div> Run <code>pre-commit install</code> to install pre-commit into your git hooks. pre-commit will now run on every commit. Every time you clone a project using pre-commit running <code>pre-commit install</code> should always be the first thing you do. If you want to manually run all pre-commit hooks on a repository, run <code>pre-commit run --all-files</code>. To run individual hooks use <code>pre-commit run <hook_id></code>. The first time pre-commit runs on a file it will automatically download, install, and run the hook. Note that running a hook for the first time may be slow. For example: If the machine does not have node installed, pre-commit will download and build a copy of node. <div class="highlight pre-commit"><pre>$ pre-commit install pre-commit installed at /home/asottile/workspace/pytest/.git/hooks/pre-commit $ git commit -m "Add super awesome feature" black....................................................................Passed blacken-docs.........................................(no files to check)Skipped Trim Trailing Whitespace.................................................Passed Fix End of Files.........................................................Passed Check Yaml...........................................(no files to check)Skipped Debug Statements (Python)................................................Passed Flake8...................................................................Passed Reorder python imports...................................................Passed pyupgrade................................................................Passed rst ``code`` is two backticks........................(no files to check)Skipped rst..................................................(no files to check)Skipped changelog filenames..................................(no files to check)Skipped [main 146c6c2c] Add super awesome feature 1 file changed, 1 insertion(+) </pre></div> </div> <div id="new-hooks"> <div class="page-header"><h1 id="creating-new-hooks"> Creating new hooks <a href="#creating-new-hooks" class="text-decoration-none">¶</a></h1> </div> pre-commit currently supports hooks written in <a href="#supported-languages">many languages</a>. As long as your git repo is an installable package (gem, npm, pypi, etc.) or exposes an executable, it can be used with pre-commit. Each git repo can support as many languages/hooks as you want. The hook must exit nonzero on failure or modify files. A git repo containing pre-commit plugins must contain a <code>.pre-commit-hooks.yaml</code> file that tells pre-commit: <table class="table table-bordered"><tbody><tr><td><a id="hooks-id" href="#hooks-id"><code>id</code></a> </td><td>the id of the hook - used in pre-commit-config.yaml. </td></tr><tr><td><a id="hooks-name" href="#hooks-name"><code>name</code></a> </td><td>the name of the hook - shown during hook execution. </td></tr><tr><td><a id="hooks-entry" href="#hooks-entry"><code>entry</code></a> </td><td>the entry point - the executable to run. <code>entry</code> can also contain arguments that will not be overridden such as <code>entry: autopep8 -i</code>. </td></tr><tr><td><a id="hooks-language" href="#hooks-language"><code>language</code></a> </td><td>the language of the hook - tells pre-commit how to install the hook. </td></tr><tr><td><a id="hooks-files" href="#hooks-files"><code>files</code></a> </td><td>(optional: default <code>''</code>) the pattern of files to run on. </td></tr><tr><td><a id="hooks-exclude" href="#hooks-exclude"><code>exclude</code></a> </td><td>(optional: default <code>^$</code>) exclude files that were matched by <a href="#hooks-files"><code>files</code></a>. </td></tr><tr><td><a id="hooks-types" href="#hooks-types"><code>types</code></a> </td><td>(optional: default <code>[file]</code>) list of file types to run on (AND). See <a href="#filtering-files-with-types">Filtering files with types</a>. </td></tr><tr><td><a id="hooks-types_or" href="#hooks-types_or"><code>types_or</code></a> </td><td>(optional: default <code>[]</code>) list of file types to run on (OR). See <a href="#filtering-files-with-types">Filtering files with types</a>. </td></tr><tr><td><a id="hooks-exclude_types" href="#hooks-exclude_types"><code>exclude_types</code></a> </td><td>(optional: default <code>[]</code>) the pattern of files to exclude. </td></tr><tr><td><a id="hooks-always_run" href="#hooks-always_run"><code>always_run</code></a> </td><td>(optional: default <code>false</code>) if <code>true</code> this hook will run even if there are no matching files. </td></tr><tr><td><a id="hooks-fail_fast" href="#hooks-fail_fast"><code>fail_fast</code></a> </td><td>(optional: default <code>false</code>) if <code>true</code> pre-commit will stop running hooks if this hook fails. </td></tr><tr><td><a id="hooks-verbose" href="#hooks-verbose"><code>verbose</code></a> </td><td>(optional: default <code>false</code>) if <code>true</code>, forces the output of the hook to be printed even when the hook passes. </td></tr><tr><td><a id="hooks-pass_filenames" href="#hooks-pass_filenames"><code>pass_filenames</code></a> </td><td>(optional: default <code>true</code>) if <code>false</code> no filenames will be passed to the hook. </td></tr><tr><td><a id="hooks-require_serial" href="#hooks-require_serial"><code>require_serial</code></a> </td><td>(optional: default <code>false</code>) if <code>true</code> this hook will execute using a single process instead of in parallel. </td></tr><tr><td><a id="hooks-description" href="#hooks-description"><code>description</code></a> </td><td>(optional: default <code>''</code>) description of the hook. used for metadata purposes only. </td></tr><tr><td><a id="hooks-language_version" href="#hooks-language_version"><code>language_version</code></a> </td><td>(optional: default <code>default</code>) see <a href="#overriding-language-version">Overriding language version</a>. </td></tr><tr><td><a id="hooks-minimum_pre_commit_version" href="#hooks-minimum_pre_commit_version"><code>minimum_pre_commit_version</code></a> </td><td>(optional: default <code>'0'</code>) allows one to indicate a minimum compatible pre-commit version. </td></tr><tr><td><a id="hooks-args" href="#hooks-args"><code>args</code></a> </td><td>(optional: default <code>[]</code>) list of additional parameters to pass to the hook. </td></tr><tr><td><a id="hooks-stages" href="#hooks-stages"><code>stages</code></a> </td><td>(optional: default (all stages)) selects which git hook(s) to run for. See <a href="#confining-hooks-to-run-at-certain-stages">Confining hooks to run at certain stages</a>. </td></tr></tbody></table>For example: <div class="highlight yaml"><pre>- id: trailing-whitespace name: Trim Trailing Whitespace description: This hook trims trailing whitespace. entry: trailing-whitespace-fixer language: python types: [text] </pre></div> <h2 id="developing-hooks-interactively"> Developing hooks interactively <a href="#developing-hooks-interactively" class="text-decoration-none">¶</a></h2> Since the <a href="#repos-repo"><code>repo</code></a> property of <code>.pre-commit-config.yaml</code> can refer to anything that <code>git clone ...</code> understands, it's often useful to point it at a local directory while developing hooks. <a href="#pre-commit-try-repo"><code>pre-commit try-repo</code></a> streamlines this process by enabling a quick way to try out a repository. Here's how one might work interactively: note: you may need to provide <code>--commit-msg-filename</code> when using this command with hook types <code>prepare-commit-msg</code> and <code>commit-msg</code>. a commit is not necessary to <code>try-repo</code> on a local directory. <code>pre-commit</code> will clone any tracked uncommitted changes. <div class="highlight pre-commit"><pre>~/work/hook-repo $ git checkout origin/main -b feature # ... make some changes # In another terminal or tab ~/work/other-repo $ pre-commit try-repo ../hook-repo foo --verbose --all-files =============================================================================== Using config: =============================================================================== repos: - repo: ../hook-repo rev: 84f01ac09fcd8610824f9626a590b83cfae9bcbd hooks: - id: foo =============================================================================== [INFO] Initializing environment for ../hook-repo. Foo......................................................................Passed - hook id: foo - duration: 0.02s Hello from foo hook! </pre></div> <h2 id="supported-languages"> Supported languages <a href="#supported-languages" class="text-decoration-none">¶</a></h2> <ul> <li><a href="#conda">conda</a></li> <li><a href="#coursier">coursier</a></li> <li><a href="#dart">dart</a></li> <li><a href="#docker">docker</a></li> <li><a href="#docker_image">docker_image</a></li> <li><a href="#dotnet">dotnet</a></li> <li><a href="#fail">fail</a></li> <li><a href="#golang">golang</a></li> <li><a href="#haskell">haskell</a></li> <li><a href="#lua">lua</a></li> <li><a href="#node">node</a></li> <li><a href="#perl">perl</a></li> <li><a href="#python">python</a></li> <li><a href="#r">r</a></li> <li><a href="#ruby">ruby</a></li> <li><a href="#rust">rust</a></li> <li><a href="#swift">swift</a></li> <li><a href="#pygrep">pygrep</a></li> <li><a href="#script">script</a></li> <li><a href="#system">system</a></li> </ul> <h3 id="conda"> conda <a href="#conda" class="text-decoration-none">¶</a></h3> The hook repository must contain an <code>environment.yml</code> file which will be used via <code>conda env create --file environment.yml ...</code> to create the environment. The <code>conda</code> language also supports <a href="#config-additional_dependencies"><code>additional_dependencies</code></a> and will pass any of the values directly into <code>conda install</code>. This language can therefore be used with <a href="#repository-local-hooks">local</a> hooks. <code>mamba</code> or <code>micromamba</code> can be used to install instead via the <code>PRE_COMMIT_USE_MAMBA=1</code> or <code>PRE_COMMIT_USE_MICROMAMBA=1</code> environment variables. Support: <code>conda</code> hooks work as long as there is a system-installed <code>conda</code> binary (such as <a href="https://docs.conda.io/en/latest/miniconda.html"><code>miniconda</code></a>). It has been tested on linux, macOS, and windows. <h3 id="coursier"> coursier <a href="#coursier" class="text-decoration-none">¶</a></h3> The hook repository must have a <code>.pre-commit-channel</code> folder and that folder must contain the coursier <a href="https://get-coursier.io/docs/2.0.0-RC6-10/cli-install.html#application-descriptor-reference">application descriptors</a> for the hook to install. For configuring coursier hooks, your <a href="#hooks-entry"><code>entry</code></a> should correspond to an executable installed from the repository's <code>.pre-commit-channel</code> folder. Support: <code>coursier</code> hooks are known to work on any system which has the <code>cs</code> or <code>coursier</code> package manager installed. The specific coursier applications you install may depend on various versions of the JVM, consult the hooks' documentation for clarification. It has been tested on linux. pre-commit also supports the <code>coursier</code> naming of the package manager executable. new in 3.0.0: <code>language: coursier</code> hooks now support <code>repo: local</code> and <code>additional_dependencies</code>. <h3 id="dart"> dart <a href="#dart" class="text-decoration-none">¶</a></h3> The hook repository must have a <code>pubspec.yaml</code> -- this must contain an <code>executables</code> section which will list the binaries that will be available after installation. Match the <a href="#hooks-entry"><code>entry</code></a> to an executable. <code>pre-commit</code> will build each executable using <code>dart compile exe bin/{executable}.dart</code>. <code>language: dart</code> also supports <a href="#config-additional_dependencies"><code>additional_dependencies</code></a>. to specify a version for a dependency, separate the package name by a <code>:</code>: <div class="highlight yaml"><pre> additional_dependencies: ['hello_world_dart:1.0.0'] </pre></div> Support: <code>dart</code> hooks are known to work on any system which has the <code>dart</code> sdk installed. It has been tested on linux, macOS, and windows. <h3 id="docker"> docker <a href="#docker" class="text-decoration-none">¶</a></h3> The hook repository must have a <code>Dockerfile</code>. It will be installed via <code>docker build .</code>. Running Docker hooks requires a running Docker engine on your host. For configuring Docker hooks, your <a href="#hooks-entry"><code>entry</code></a> should correspond to an executable inside the Docker container, and will be used to override the default container entrypoint. Your Docker <code>CMD</code> will not run when pre-commit passes a file list as arguments to the run container command. Docker allows you to use any language that's not supported by pre-commit as a builtin. pre-commit will automatically mount the repository source as a volume using <code>-v $PWD:/src:rw,Z</code> and set the working directory using <code>--workdir /src</code>. Support: docker hooks are known to work on any system which has a working <code>docker</code> executable. It has been tested on linux and macOS. Hooks that are run via <code>boot2docker</code> are known to be unable to make modifications to files. See <a href="https://github.com/pre-commit/pre-commit-docker-flake8">this repository</a> for an example Docker-based hook. <h3 id="docker_image"> docker_image <a href="#docker_image" class="text-decoration-none">¶</a></h3> A more lightweight approach to <code>docker</code> hooks. The <code>docker_image</code> "language" uses existing docker images to provide hook executables. <code>docker_image</code> hooks can be conveniently configured as <a href="#repository-local-hooks">local</a> hooks. The <a href="#hooks-entry"><code>entry</code></a> specifies the docker tag to use. If an image has an <code>ENTRYPOINT</code> defined, nothing special is needed to hook up the executable. If the container does not specify an <code>ENTRYPOINT</code> or you want to change the entrypoint you can specify it as well in your <a href="#hooks-entry"><code>entry</code></a>. For example: <div class="highlight yaml"><pre>- id: dockerfile-provides-entrypoint name: ... language: docker_image entry: my.registry.example.com/docker-image-1:latest - id: dockerfile-no-entrypoint-1 name: ... language: docker_image entry: --entrypoint my-exe my.registry.example.com/docker-image-2:latest # Alternative equivalent solution - id: dockerfile-no-entrypoint-2 name: ... language: docker_image entry: my.registry.example.com/docker-image-3:latest my-exe </pre></div> <h3 id="dotnet"> dotnet <a href="#dotnet" class="text-decoration-none">¶</a></h3> dotnet hooks are installed using the system installation of the dotnet CLI. Hook repositories must contain a dotnet CLI tool which can be <code>pack</code>ed and <code>install</code>ed as per <a href="https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools-how-to-create">this</a> example. The <code>entry</code> should match an executable created by building the repository. Additional dependencies are not currently supported. Support: dotnet hooks are known to work on any system which has the dotnet CLI installed. It has been tested on linux and windows. <h3 id="fail"> fail <a href="#fail" class="text-decoration-none">¶</a></h3> A lightweight <a href="#hooks-language"><code>language</code></a> to forbid files by filename. The <code>fail</code> language is especially useful for <a href="#repository-local-hooks">local</a> hooks. The <a href="#hooks-entry"><code>entry</code></a> will be printed when the hook fails. It is suggested to provide a brief description for <a href="#hooks-name"><code>name</code></a> and more verbose fix instructions in <a href="#hooks-entry"><code>entry</code></a>. Here's an example which prevents any file except those ending with <code>.rst</code> from being added to the <code>changelog</code> directory: <div class="highlight yaml"><pre>- repo: local hooks: - id: changelogs-rst name: changelogs must be rst entry: changelog filenames must end in .rst language: fail files: 'changelog/.*(?<!\.rst)$' </pre></div> <h3 id="golang"> golang <a href="#golang" class="text-decoration-none">¶</a></h3> The hook repository must contain go source code. It will be installed via <code>go install ./...</code>. pre-commit will create an isolated <code>GOPATH</code> for each hook and the <a href="#hooks-entry"><code>entry</code></a> should match an executable which will get installed into the <code>GOPATH</code>'s <code>bin</code> directory. This language supports <code>additional_dependencies</code> and will pass any of the values directly to <code>go install</code>. It can be used as a <code>repo: local</code> hook. changed in 2.17.0: previously <code>go get ./...</code> was used new in 3.0.0: pre-commit will bootstrap <code>go</code> if it is not present. <code>language: golang</code> also now supports <code>language_version</code> Support: golang hooks are known to work on any system which has go installed. It has been tested on linux, macOS, and windows. <h3 id="haskell"> haskell <a href="#haskell" class="text-decoration-none">¶</a></h3> new in 3.4.0 The hook repository must have one or more <code>*.cabal</code> files. Once installed the <code>executable</code>s from these packages will be available to use with <code>entry</code>. This language supports <code>additional_dependencies</code> so it can be used as a <code>repo: local</code> hook. Support: haskell hooks are known to work on any system which has <code>cabal</code> installed. It has been tested on linux, macOS, and windows. <h3 id="lua"> lua <a href="#lua" class="text-decoration-none">¶</a></h3> Lua hooks are installed with the version of Lua that is used by Luarocks. Support: Lua hooks are known to work on any system which has Luarocks installed. It has been tested on linux and macOS and may work on windows. <h3 id="node"> node <a href="#node" class="text-decoration-none">¶</a></h3> The hook repository must have a <code>package.json</code>. It will be installed via <code>npm install .</code>. The installed package will provide an executable that will match the <a href="#hooks-entry"><code>entry</code></a> – usually through <code>bin</code> in package.json. Support: node hooks work without any system-level dependencies. It has been tested on linux, windows, and macOS and may work under cygwin. <h3 id="perl"> perl <a href="#perl" class="text-decoration-none">¶</a></h3> Perl hooks are installed using the system installation of <a href="https://perldoc.perl.org/cpan">cpan</a>, the CPAN package installer that comes with Perl. Hook repositories must have something that <code>cpan</code> supports, typically <code>Makefile.PL</code> or <code>Build.PL</code>, which it uses to install an executable to use in the <a href="#hooks-entry"><code>entry</code></a> definition for your hook. The repository will be installed via <code>cpan -T .</code> (with the installed files stored in your pre-commit cache, not polluting other Perl installations). When specifying <a href="#config-additional_dependencies"><code>additional_dependencies</code></a> for Perl, you can use any of the <a href="https://perldoc.perl.org/CPAN#get%2c-make%2c-test%2c-install%2c-clean-modules-or-distributions">install argument formats understood by <code>cpan</code></a>. Support: Perl hooks currently require a pre-existing Perl installation, including the <code>cpan</code> tool in <code>PATH</code>. It has been tested on linux, macOS, and Windows. <h3 id="python"> python <a href="#python" class="text-decoration-none">¶</a></h3> The hook repository must be installable via <code>pip install .</code> (usually by either <code>setup.py</code> or <code>pyproject.toml</code>). The installed package will provide an executable that will match the <a href="#hooks-entry"><code>entry</code></a> – usually through <code>console_scripts</code> or <code>scripts</code> in setup.py. This language also supports <code>additional_dependencies</code> so it can be used with <a href="#repository-local-hooks">local</a> hooks. The specified dependencies will be appended to the <code>pip install</code> command. Support: python hooks work without any system-level dependencies. It has been tested on linux, macOS, windows, and cygwin. <h3 id="r"> r <a href="#r" class="text-decoration-none">¶</a></h3> This hook repository must have a <code>renv.lock</code> file that will be restored with <a href="https://rstudio.github.io/renv/reference/restore.html"><code>renv::restore()</code></a> on hook installation. If the repository is an R package (i.e. has <code>Type: Package</code> in <code>DESCRIPTION</code>), it is installed. The supported syntax in <a href="#hooks-entry"><code>entry</code></a> is <code>Rscript -e {expression}</code> or <code>Rscript path/relative/to/hook/root</code>. The R Startup process is skipped (emulating <code>--vanilla</code>), as all configuration should be exposed via <a href="#hooks-args"><code>args</code></a> for maximal transparency and portability. When specifying <a href="#config-additional_dependencies"><code>additional_dependencies</code></a> for R, you can use any of the install argument formats understood by <a href="https://rstudio.github.io/renv/reference/install.html#examples"><code>renv::install()</code></a>. Support: <code>r</code> hooks work as long as <a href="https://www.r-project.org"><code>R</code></a> is installed and on <code>PATH</code>. It has been tested on linux, macOS, and windows. <h3 id="ruby"> ruby <a href="#ruby" class="text-decoration-none">¶</a></h3> The hook repository must have a <code>*.gemspec</code>. It will be installed via <code>gem build *.gemspec && gem install *.gem</code>. The installed package will produce an executable that will match the <a href="#hooks-entry"><code>entry</code></a> – usually through <code>executables</code> in your gemspec. Support: ruby hooks work without any system-level dependencies. It has been tested on linux and macOS and may work under cygwin. <h3 id="rust"> rust <a href="#rust" class="text-decoration-none">¶</a></h3> Rust hooks are installed using <a href="https://github.com/rust-lang/cargo">Cargo</a>, Rust's official package manager. Hook repositories must have a <code>Cargo.toml</code> file which produces at least one binary (<a href="https://github.com/chriskuehl/example-rust-pre-commit-hook">example</a>), whose name should match the <a href="#hooks-entry"><code>entry</code></a> definition for your hook. The repo will be installed via <code>cargo install --bins</code> (with the binaries stored in your pre-commit cache, not polluting your user-level Cargo installations). When specifying <a href="#config-additional_dependencies"><code>additional_dependencies</code></a> for Rust, you can use the syntax <code>{package_name}:{package_version}</code> to specify a new library dependency (used to build your hook repo), or the special syntax <code>cli:{package_name}:{package_version}</code> for a CLI dependency (built separately, with binaries made available for use by hooks). pre-commit will bootstrap <code>rust</code> if it is not present. <code>language: rust</code> also supports <code>language_version</code> Support: It has been tested on linux, Windows, and macOS. <h3 id="swift"> swift <a href="#swift" class="text-decoration-none">¶</a></h3> The hook repository must have a <code>Package.swift</code>. It will be installed via <code>swift build -c release</code>. The <a href="#hooks-entry"><code>entry</code></a> should match an executable created by building the repository. Support: swift hooks are known to work on any system which has swift installed. It has been tested on linux and macOS. <h3 id="pygrep"> pygrep <a href="#pygrep" class="text-decoration-none">¶</a></h3> A cross-platform python implementation of <code>grep</code> – pygrep hooks are a quick way to write a simple hook which prevents commits by file matching. Specify the regex as the <a href="#hooks-entry"><code>entry</code></a>. The <a href="#hooks-entry"><code>entry</code></a> may be any python <a href="#regular-expressions">regular expression</a>. For case insensitive regexes you can apply the <code>(?i)</code> flag as the start of your entry, or use <code>args: [-i]</code>. For multiline matches, use <code>args: [--multiline]</code>. To require all files to match, use <code>args: [--negate]</code>. Support: pygrep hooks are supported on all platforms which pre-commit runs on. <h3 id="script"> script <a href="#script" class="text-decoration-none">¶</a></h3> Script hooks provide a way to write simple scripts which validate files. The <a href="#hooks-entry"><code>entry</code></a> should be a path relative to the root of the hook repository. This hook type will not be given a virtual environment to work with – if it needs additional dependencies the consumer must install them manually. Support: the support of script hooks depend on the scripts themselves. <h3 id="system"> system <a href="#system" class="text-decoration-none">¶</a></h3> System hooks provide a way to write hooks for system-level executables which don't have a supported language above (or have special environment requirements that don't allow them to run in isolation such as pylint). This hook type will not be given a virtual environment to work with – if it needs additional dependencies the consumer must install them manually. Support: the support of system hooks depend on the executables. </div> <div id="cli"> <div class="page-header"><h1 id="command-line-interface"> Command line interface <a href="#command-line-interface" class="text-decoration-none">¶</a></h1> </div> All pre-commit commands take the following options: <ul> <li><code>--color {auto,always,never}</code>: whether to use color in output. Defaults to <code>auto</code>. can be overridden by using <code>PRE_COMMIT_COLOR={auto,always,never}</code> or disabled using <code>TERM=dumb</code>.</li> <li><code>-c CONFIG</code>, <code>--config CONFIG</code>: path to alternate config file</li> <li><code>-h</code>, <code>--help</code>: show help and available options.</li> </ul> <code>pre-commit</code> exits with specific codes: <ul> <li><code>1</code>: a detected / expected error</li> <li><code>3</code>: an unexpected error</li> <li><code>130</code>: the process was interrupted by <code>^C</code></li> </ul> <h2 id="pre-commit-autoupdate"> pre-commit autoupdate [options] <a href="#pre-commit-autoupdate" class="text-decoration-none">¶</a></h2> Auto-update pre-commit config to the latest repos' versions. Options: <ul> <li><code>--bleeding-edge</code>: update to the bleeding edge of the default branch instead of the latest tagged version (the default behaviour).</li> <li><code>--freeze</code>: Store "frozen" hashes in <a href="#repos-rev"><code>rev</code></a> instead of tag names.</li> <li><code>--repo REPO</code>: Only update this repository. This option may be specified multiple times.</li> <li><code>-j</code> / <code>--jobs</code>: new in 3.3.0 Number of threads to use (default: 1).</li> </ul> Here are some sample invocations using this <code>.pre-commit-config.yaml</code>: <div class="highlight yaml"><pre>repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.1.0 hooks: - id: trailing-whitespace - repo: https://github.com/asottile/pyupgrade rev: v1.25.0 hooks: - id: pyupgrade args: [--py36-plus] </pre></div> <div class="highlight console"><pre>$ : default: update to latest tag on default branch $ pre-commit autoupdate # by default: pick tags Updating https://github.com/pre-commit/pre-commit-hooks ... updating v2.1.0 -> v2.4.0. Updating https://github.com/asottile/pyupgrade ... updating v1.25.0 -> v1.25.2. $ grep rev: .pre-commit-config.yaml rev: v2.4.0 rev: v1.25.2 </pre></div> <div class="highlight console"><pre>$ : update a specific repository to the latest revision of the default branch $ pre-commit autoupdate --bleeding-edge --repo https://github.com/pre-commit/pre-commit-hooks Updating https://github.com/pre-commit/pre-commit-hooks ... updating v2.1.0 -> 5df1a4bf6f04a1ed3a643167b38d502575e29aef. $ grep rev: .pre-commit-config.yaml rev: 5df1a4bf6f04a1ed3a643167b38d502575e29aef rev: v1.25.0 </pre></div> <div class="highlight console"><pre>$ : update to frozen versions $ pre-commit autoupdate --freeze Updating https://github.com/pre-commit/pre-commit-hooks ... updating v2.1.0 -> v2.4.0 (frozen). Updating https://github.com/asottile/pyupgrade ... updating v1.25.0 -> v1.25.2 (frozen). $ grep rev: .pre-commit-config.yaml rev: 0161422b4e09b47536ea13f49e786eb3616fe0d7 # frozen: v2.4.0 rev: 34a269fd7650d264e4de7603157c10d0a9bb8211 # frozen: v1.25.2 </pre></div> pre-commit will preferentially pick tags containing a <code>.</code> if there are ties. <h2 id="pre-commit-clean"> pre-commit clean [options] <a href="#pre-commit-clean" class="text-decoration-none">¶</a></h2> Clean out cached pre-commit files. Options: (no additional options) <h2 id="pre-commit-gc"> pre-commit gc [options] <a href="#pre-commit-gc" class="text-decoration-none">¶</a></h2> Clean unused cached repos. <code>pre-commit</code> keeps a cache of installed hook repositories which grows over time. This command can be run periodically to clean out unused repos from the cache directory. Options: (no additional options) <h2 id="pre-commit-init-templatedir"> pre-commit init-templatedir DIRECTORY [options] <a href="#pre-commit-init-templatedir" class="text-decoration-none">¶</a></h2> Install hook script in a directory intended for use with <code>git config init.templateDir</code>. Options: <ul> <li><code>-t HOOK_TYPE, --hook-type HOOK_TYPE</code>: which hook type to install.</li> </ul> Some example useful invocations: <div class="highlight bash"><pre>git config --global init.templateDir ~/.git-template pre-commit init-templatedir ~/.git-template </pre></div> For Windows cmd.exe use <code>%HOMEPATH%</code> instead of <code>~</code>: <div class="highlight batch"><pre>pre-commit init-templatedir %HOMEPATH%\.git-template </pre></div> For Windows PowerShell use <code>$HOME</code> instead of <code>~</code>: <div class="highlight powershell"><pre>pre-commit init-templatedir $HOME\.git-template </pre></div> Now whenever a repository is cloned or created, it will have the hooks set up already! <h2 id="pre-commit-install"> pre-commit install [options] <a href="#pre-commit-install" class="text-decoration-none">¶</a></h2> Install the pre-commit script. Options: <ul> <li><code>-f</code>, <code>--overwrite</code>: Replace any existing git hooks with the pre-commit script.</li> <li><code>--install-hooks</code>: Also install environments for all available hooks now (rather than when they are first executed). See <a href="#pre-commit-install-hooks"><code>pre-commit install-hooks</code></a>.</li> <li><code>-t HOOK_TYPE, --hook-type HOOK_TYPE</code>: Specify which hook type to install.</li> <li><code>--allow-missing-config</code>: Hook scripts will permit a missing configuration file.</li> </ul> Some example useful invocations: <ul> <li><code>pre-commit install</code>: Default invocation. Installs the hook scripts alongside any existing git hooks.</li> <li><code>pre-commit install --install-hooks --overwrite</code>: Idempotently replaces existing git hook scripts with pre-commit, and also installs hook environments.</li> </ul> <code>pre-commit install</code> will install hooks from <a href="#top_level-default_install_hook_types"><code>default_install_hook_types</code></a> if <code>--hook-type</code> is not specified on the command line. <h2 id="pre-commit-install-hooks"> pre-commit install-hooks [options] <a href="#pre-commit-install-hooks" class="text-decoration-none">¶</a></h2> Install all missing environments for the available hooks. Unless this command or <code>install --install-hooks</code> is executed, each hook's environment is created the first time the hook is called. Each hook is initialized in a separate environment appropriate to the language the hook is written in. See <a href="#supported-languages">supported languages</a>. This command does not install the pre-commit script. To install the script along with the hook environments in one command, use <code>pre-commit install --install-hooks</code>. Options: (no additional options) <h2 id="pre-commit-migrate-config"> pre-commit migrate-config [options] <a href="#pre-commit-migrate-config" class="text-decoration-none">¶</a></h2> Migrate list configuration to the new map configuration format. Options: (no additional options) <h2 id="pre-commit-run"> pre-commit run [hook-id] [options] <a href="#pre-commit-run" class="text-decoration-none">¶</a></h2> Run hooks. Options: <ul> <li><code>[hook-id]</code>: specify a single hook-id to run only that hook.</li> <li><code>-a</code>, <code>--all-files</code>: run on all the files in the repo.</li> <li><code>--files [FILES [FILES ...]]</code>: specific filenames to run hooks on.</li> <li><code>--from-ref FROM_REF</code> + <code>--to-ref TO_REF</code>: run against the files changed between <code>FROM_REF...TO_REF</code> in git.</li> <li><code>--hook-stage STAGE</code>: select a <a href="#confining-hooks-to-run-at-certain-stages"><code>stage</code> to run</a>.</li> <li><code>--show-diff-on-failure</code>: when hooks fail, run <code>git diff</code> directly afterward.</li> <li><code>-v</code>, <code>--verbose</code>: produce hook output independent of success. Include hook ids in output.</li> </ul> Some example useful invocations: <ul> <li><code>pre-commit run</code>: this is what pre-commit runs by default when committing. This will run all hooks against currently staged files.</li> <li><code>pre-commit run --all-files</code>: run all the hooks against all the files. This is a useful invocation if you are using pre-commit in CI.</li> <li><code>pre-commit run flake8</code>: run the <code>flake8</code> hook against all staged files.</li> <li><code>git ls-files -- '*.py' | xargs pre-commit run --files</code>: run all hooks against all <code>*.py</code> files in the repository.</li> <li><code>pre-commit run --from-ref HEAD^^^ --to-ref HEAD</code>: run against the files that have changed between <code>HEAD^^^</code> and <code>HEAD</code>. This form is useful when leveraged in a pre-receive hook.</li> </ul> <h2 id="pre-commit-sample-config"> pre-commit sample-config [options] <a href="#pre-commit-sample-config" class="text-decoration-none">¶</a></h2> Produce a sample <code>.pre-commit-config.yaml</code>. Options: (no additional options) <h2 id="pre-commit-try-repo"> pre-commit try-repo REPO [options] <a href="#pre-commit-try-repo" class="text-decoration-none">¶</a></h2> Try the hooks in a repository, useful for developing new hooks. <code>try-repo</code> can also be used for testing out a repository before adding it to your configuration. <code>try-repo</code> prints a configuration it generates based on the remote hook repository before running the hooks. Options: <ul> <li><code>REPO</code>: required clonable hooks repository. Can be a local path on disk.</li> <li><code>--ref REF</code>: Manually select a ref to run against, otherwise the <code>HEAD</code> revision will be used.</li> <li><code>pre-commit try-repo</code> also supports all available options for <a href="#pre-commit-run"><code>pre-commit run</code></a>.</li> </ul> Some example useful invocations: <ul> <li><code>pre-commit try-repo https://github.com/pre-commit/pre-commit-hooks</code>: runs all the hooks in the latest revision of <code>pre-commit/pre-commit-hooks</code>.</li> <li><code>pre-commit try-repo ../path/to/repo</code>: run all the hooks in a repository on disk.</li> <li><code>pre-commit try-repo ../pre-commit-hooks flake8</code>: run only the <code>flake8</code> hook configured in a local <code>../pre-commit-hooks</code> repository.</li> <li>See <a href="#pre-commit-run"><code>pre-commit run</code></a> for more useful <code>run</code> invocations which are also supported by <code>pre-commit try-repo</code>.</li> </ul> <h2 id="pre-commit-uninstall"> pre-commit uninstall [options] <a href="#pre-commit-uninstall" class="text-decoration-none">¶</a></h2> Uninstall the pre-commit script. Options: <ul> <li><code>-t HOOK_TYPE, --hook-type HOOK_TYPE</code>: which hook type to uninstall.</li> </ul> </div> <div id="advanced"> <div class="page-header"><h1 id="advanced-features"> Advanced features <a href="#advanced-features" class="text-decoration-none">¶</a></h1> </div> <h2 id="running-in-migration-mode"> Running in migration mode <a href="#running-in-migration-mode" class="text-decoration-none">¶</a></h2> By default, if you have existing hooks <code>pre-commit install</code> will install in a migration mode which runs both your existing hooks and hooks for pre-commit. To disable this behavior, pass <code>-f</code> / <code>--overwrite</code> to the <code>install</code> command. If you decide not to use pre-commit, <code>pre-commit uninstall</code> will restore your hooks to the state prior to installation. <h2 id="temporarily-disabling-hooks"> Temporarily disabling hooks <a href="#temporarily-disabling-hooks" class="text-decoration-none">¶</a></h2> Not all hooks are perfect so sometimes you may need to skip execution of one or more hooks. pre-commit solves this by querying a <code>SKIP</code> environment variable. The <code>SKIP</code> environment variable is a comma separated list of hook ids. This allows you to skip a single hook instead of <code>--no-verify</code>ing the entire commit. <div class="highlight console"><pre>$ SKIP=flake8 git commit -m "foo" </pre></div> <h2 id="confining-hooks-to-run-at-certain-stages"> Confining hooks to run at certain stages <a href="#confining-hooks-to-run-at-certain-stages" class="text-decoration-none">¶</a></h2> pre-commit supports many different types of <code>git</code> hooks (not just <code>pre-commit</code>!). Providers of hooks can select which git hooks they run on by setting the <a href="#hooks-stages"><code>stages</code></a> property in <code>.pre-commit-hooks.yaml</code> -- this can also be overridden by setting <a href="#config-stages"><code>stages</code></a> in <code>.pre-commit-config.yaml</code>. If <code>stages</code> is not set in either of those places the default value will be pulled from the top-level <a href="#top_level-default_stages"><code>default_stages</code></a> option (which defaults to all stages). By default, tools are enabled for <a href="#supported-git-hooks">every hook type</a> that pre-commit supports. new in 3.2.0: The values of <code>stages</code> match the hook names. Previously, <code>commit</code>, <code>push</code>, and <code>merge-commit</code> matched <code>pre-commit</code>, <code>pre-push</code>, and <code>pre-merge-commit</code> respectively. The <code>manual</code> stage (via <code>stages: [manual]</code>) is a special stage which will not be automatically triggered by any <code>git</code> hook -- this is useful if you want to add a tool which is not automatically run, but is run on demand using <code>pre-commit run --hook-stage manual [hookid]</code>. If you are authoring a tool, it is usually a good idea to provide an appropriate <code>stages</code> property. For example a reasonable setting for a linter or code formatter would be <code>stages: [pre-commit, pre-merge-commit, pre-push, manual]</code>. To install <code>pre-commit</code> for particular git hooks, pass <code>--hook-type</code> to <code>pre-commit install</code>. This can be specified multiple times such as: <div class="highlight console"><pre>$ pre-commit install --hook-type pre-commit --hook-type pre-push pre-commit installed at .git/hooks/pre-commit pre-commit installed at .git/hooks/pre-push </pre></div> Additionally, one can specify a default set of git hook types to be installed for by setting the top-level <a href="#top_level-default_install_hook_types"><code>default_install_hook_types</code></a>. For example: <div class="highlight yaml"><pre>default_install_hook_types: [pre-commit, pre-push, commit-msg] </pre></div> <div class="highlight console"><pre>$ pre-commit install pre-commit installed at .git/hooks/pre-commit pre-commit installed at .git/hooks/pre-push pre-commit installed at .git/hooks/commit-msg </pre></div> <a name="pre-commit-during-commits"></a> <a name="pre-commit-during-merges"></a> <a name="pre-commit-during-clean-merges"></a> <a name="pre-commit-during-push"></a> <a name="pre-commit-for-commit-messages"></a> <a name="pre-commit-for-switching-branches"></a> <a name="pre-commit-for-rewriting"></a> <h2 id="supported-git-hooks"> Supported git hooks <a href="#supported-git-hooks" class="text-decoration-none">¶</a></h2> <ul> <li><a href="#commit-msg">commit-msg</a></li> <li><a href="#post-checkout">post-checkout</a></li> <li><a href="#post-commit">post-commit</a></li> <li><a href="#post-merge">post-merge</a></li> <li><a href="#post-rewrite">post-rewrite</a></li> <li><a href="#pre-commit">pre-commit</a></li> <li><a href="#pre-merge-commit">pre-merge-commit</a></li> <li><a href="#pre-push">pre-push</a></li> <li><a href="#pre-rebase">pre-rebase</a></li> <li><a href="#prepare-commit-msg">prepare-commit-msg</a></li> </ul> <h3 id="commit-msg"> commit-msg <a href="#commit-msg" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_commit_msg">git commit-msg docs</a> <code>commit-msg</code> hooks will be passed a single filename -- this file contains the current contents of the commit message to be validated. The commit will be aborted if there is a nonzero exit code. <h3 id="post-checkout"> post-checkout <a href="#post-checkout" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_post_checkout">git post-checkout docs</a> post-checkout hooks run after a <code>checkout</code> has occurred and can be used to set up or manage state in the repository. <code>post-checkout</code> hooks do not operate on files so they must be set as <code>always_run: true</code> or they will always be skipped. environment variables: <ul> <li><code>PRE_COMMIT_FROM_REF</code>: the first argument to the <code>post-checkout</code> git hook</li> <li><code>PRE_COMMIT_TO_REF</code>: the second argument to the <code>post-checkout</code> git hook</li> <li><code>PRE_COMMIT_CHECKOUT_TYPE</code>: the third argument to the <code>post-checkout</code> git hook</li> </ul> <h3 id="post-commit"> post-commit <a href="#post-commit" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_post_commit">git post-commit docs</a> <code>post-commit</code> runs after the commit has already succeeded so it cannot be used to prevent the commit from happening. <code>post-commit</code> hooks do not operate on files so they must be set as <code>always_run: true</code> or they will always be skipped. <h3 id="post-merge"> post-merge <a href="#post-merge" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_post_merge">git post-merge docs</a> <code>post-merge</code> runs after a successful <code>git merge</code>. <code>post-merge</code> hooks do not operate on files so they must be set as <code>always_run: true</code> or they will always be skipped. environment variables: <ul> <li><code>PRE_COMMIT_IS_SQUASH_MERGE</code>: the first argument to the <code>post-merge</code> git hook.</li> </ul> <h3 id="post-rewrite"> post-rewrite <a href="#post-rewrite" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_post_rewrite">git post-rewrite docs</a> <code>post-rewrite</code> runs after a git command which modifies history such as <code>git commit --amend</code> or <code>git rebase</code>. <code>post-rewrite</code> hooks do not operate on files so they must be set as <code>always_run: true</code> or they will always be skipped. environment variables: <ul> <li><code>PRE_COMMIT_REWRITE_COMMAND</code>: the first argument to the <code>post-rewrite</code> git hook.</li> </ul> <h3 id="pre-commit"> pre-commit <a href="#pre-commit" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_pre_commit">git pre-commit docs</a> <code>pre-commit</code> is triggered before the commit is finalized to allow checks on the code being committed. Running hooks on unstaged changes can lead to both false-positives and false-negatives during committing. pre-commit only runs on the staged contents of files by temporarily stashing the unstaged changes while running hooks. <h3 id="pre-merge-commit"> pre-merge-commit <a href="#pre-merge-commit" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_pre_merge_commit">git pre-merge-commit docs</a> <code>pre-merge-commit</code> fires after a merge succeeds but before the merge commit is created. This hook runs on all staged files from the merge. Note that you need to be using at least git 2.24 for this hook. <h3 id="pre-push"> pre-push <a href="#pre-push" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_pre_push">git pre-push docs</a> <code>pre-push</code> is triggered on <code>git push</code>. environment variables: <ul> <li><code>PRE_COMMIT_FROM_REF</code>: the revision that is being pushed to.</li> <li><code>PRE_COMMIT_TO_REF</code>: the local revision that is being pushed to the remote.</li> <li><code>PRE_COMMIT_REMOTE_NAME</code>: which remote is being pushed to (for example <code>origin</code>)</li> <li><code>PRE_COMMIT_REMOTE_URL</code>: the url of the remote that is being pushed to (for example <code><a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="c4a3adb084a3adb0acb1a6eaa7aba9">[email protected]</a>:pre-commit/pre-commit</code>)</li> <li><code>PRE_COMMIT_REMOTE_BRANCH</code>: the name of the remote branch to which we are pushing (for example <code>refs/heads/target-branch</code>)</li> <li><code>PRE_COMMIT_LOCAL_BRANCH</code>: the name of the local branch that is being pushed to the remote (for example <code>HEAD</code>)</li> </ul> <h3 id="pre-rebase"> pre-rebase <a href="#pre-rebase" class="text-decoration-none">¶</a></h3> new in 3.2.0 <a href="https://git-scm.com/docs/githooks#_pre_rebase">git pre-rebase docs</a> <code>pre-rebase</code> is triggered before a rebase occurs. A hook failure can cancel a rebase from occurring. <code>pre-rebase</code> hooks do not operate on files so they must be set as <code>always_run: true</code> or they will always be skipped. environment variables: <ul> <li><code>PRE_COMMIT_PRE_REBASE_UPSTREAM</code>: the first argument to the <code>pre-rebase</code> git hook</li> <li><code>PRE_COMMIT_PRE_REBASE_BRANCH</code>: the second argument to the <code>pre-rebase</code> git hook.</li> </ul> <h3 id="prepare-commit-msg"> prepare-commit-msg <a href="#prepare-commit-msg" class="text-decoration-none">¶</a></h3> <a href="https://git-scm.com/docs/githooks#_prepare_commit_msg">git prepare-commit-msg docs</a> <code>prepare-commit-msg</code> hooks will be passed a single filename -- this file may be empty or it could contain the commit message from <code>-m</code> or from other templates. <code>prepare-commit-msg</code> hooks can modify the contents of this file to change what will be committed. A hook may want to check for <code>GIT_EDITOR=:</code> as this indicates that no editor will be launched. If a hook exits nonzero, the commit will be aborted. environment variables: <ul> <li><code>PRE_COMMIT_COMMIT_MSG_SOURCE</code>: the second argument to the <code>prepare-commit-msg</code> git hook</li> <li><code>PRE_COMMIT_COMMIT_OBJECT_NAME</code>: the third argument to the <code>prepare-commit-msg</code> git hook</li> </ul> <h2 id="passing-arguments-to-hooks"> Passing arguments to hooks <a href="#passing-arguments-to-hooks" class="text-decoration-none">¶</a></h2> Sometimes hooks require arguments to run correctly. You can pass static arguments by specifying the <a href="#config-args"><code>args</code></a> property in your <code>.pre-commit-config.yaml</code> as follows: <div class="highlight yaml"><pre>- repo: https://github.com/PyCQA/flake8 rev: 4.0.1 hooks: - id: flake8 args: [--max-line-length=131] </pre></div> This will pass <code>--max-line-length=131</code> to <code>flake8</code>. <h3 id="arguments-pattern-in-hooks"> Arguments pattern in hooks <a href="#arguments-pattern-in-hooks" class="text-decoration-none">¶</a></h3> If you are writing your own custom hook, your hook should expect to receive the <a href="#config-args"><code>args</code></a> value and then a list of staged files. For example, assuming a <code>.pre-commit-config.yaml</code>: <div class="highlight yaml"><pre>- repo: https://github.com/path/to/your/hook/repo rev: badf00ddeadbeef hooks: - id: my-hook-script-id args: [--myarg1=1, --myarg1=2] </pre></div> When you next run <code>pre-commit</code>, your script will be called: <div class="highlight"><pre>path/to/script-or-system-exe --myarg1=1 --myarg1=2 dir/file1 dir/file2 file3 </pre></div> If the <a href="#config-args"><code>args</code></a> property is empty or not defined, your script will be called: <div class="highlight"><pre>path/to/script-or-system-exe dir/file1 dir/file2 file3 </pre></div> When creating local hooks, there's no reason to put command arguments into <a href="#config-args"><code>args</code></a> as there is nothing which can override them -- instead put your arguments directly in the hook <a href="#hooks-entry"><code>entry</code></a>. For example: <div class="highlight yaml"><pre>- repo: local hooks: - id: check-requirements name: check requirements files language: system entry: python -m scripts.check_requirements --compare files: ^requirements.*\.txt$ </pre></div> <h2 id="repository-local-hooks"> Repository local hooks <a href="#repository-local-hooks" class="text-decoration-none">¶</a></h2> Repository-local hooks are useful when: <ul> <li>The scripts are tightly coupled to the repository and it makes sense to distribute the hook scripts with the repository.</li> <li>Hooks require state that is only present in a built artifact of your repository (such as your app's virtualenv for pylint).</li> <li>The official repository for a linter doesn't have the pre-commit metadata.</li> </ul> You can configure repository-local hooks by specifying the <a href="#repos-repo"><code>repo</code></a> as the sentinel <code>local</code>. local hooks can use any language which supports <a href="#config-additional_dependencies"><code>additional_dependencies</code></a> or <a href="#docker_image"><code>docker_image</code></a> / <a href="#fail"><code>fail</code></a> / <a href="#pygrep"><code>pygrep</code></a> / <a href="#script"><code>script</code></a> / <a href="#system"><code>system</code></a>. This enables you to install things which previously would require a trivial mirror repository. A <code>local</code> hook must define <a href="#hooks-id"><code>id</code></a>, <a href="#hooks-name"><code>name</code></a>, <a href="#hooks-language"><code>language</code></a>, <a href="#hooks-entry"><code>entry</code></a>, and <a href="#hooks-files"><code>files</code></a> / <a href="#hooks-types"><code>types</code></a> as specified under <a href="#new-hooks">Creating new hooks</a>. Here's an example configuration with a few <code>local</code> hooks: <div class="highlight yaml"><pre>- repo: local hooks: - id: pylint name: pylint entry: pylint language: system types: [python] require_serial: true - id: check-x name: Check X entry: ./bin/check-x.sh language: script files: \.x$ - id: scss-lint name: scss-lint entry: scss-lint language: ruby language_version: 2.1.5 types: [scss] additional_dependencies: ['scss_lint:0.52.0'] </pre></div> <h2 id="meta-hooks"> meta hooks <a href="#meta-hooks" class="text-decoration-none">¶</a></h2> <code>pre-commit</code> provides several hooks which are useful for checking the pre-commit configuration itself. These can be enabled using <code>repo: meta</code>. <div class="highlight yaml"><pre>- repo: meta hooks: - id: ... </pre></div> The currently available <code>meta</code> hooks: <table class="table table-bordered"><tbody><tr><td><a id="meta-check_hooks_apply" href="#meta-check_hooks_apply"><code>check-hooks-apply</code></a> </td><td>ensures that the configured hooks apply to at least one file in the repository. </td></tr><tr><td><a id="meta-check_useless_excludes" href="#meta-check_useless_excludes"><code>check-useless-excludes</code></a> </td><td>ensures that <code>exclude</code> directives apply to any file in the repository. </td></tr><tr><td><a id="meta-identity" href="#meta-identity"><code>identity</code></a> </td><td>a simple hook which prints all arguments passed to it, useful for debugging. </td></tr></tbody></table><h2 id="automatically-enabling-pre-commit-on-repositories"> automatically enabling pre-commit on repositories <a href="#automatically-enabling-pre-commit-on-repositories" class="text-decoration-none">¶</a></h2> <code>pre-commit init-templatedir</code> can be used to set up a skeleton for <code>git</code>'s <code>init.templateDir</code> option. This means that any newly cloned repository will automatically have the hooks set up without the need to run <code>pre-commit install</code>. To configure, first set <code>git</code>'s <code>init.templateDir</code> -- in this example I'm using <code>~/.git-template</code> as my template directory. <div class="highlight console"><pre>$ git config --global init.templateDir ~/.git-template $ pre-commit init-templatedir ~/.git-template pre-commit installed at /home/asottile/.git-template/hooks/pre-commit </pre></div> Now whenever you clone a pre-commit enabled repo, the hooks will already be set up! <div class="highlight pre-commit"><pre>$ git clone -q <a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="583f312c183f312c302d3a763b3735">[email protected]</a>:asottile/pyupgrade $ cd pyupgrade $ git commit --allow-empty -m 'Hello world!' Check docstring is first.............................(no files to check)Skipped Check Yaml...........................................(no files to check)Skipped Debug Statements (Python)............................(no files to check)Skipped ... </pre></div> <code>init-templatedir</code> uses the <code>--allow-missing-config</code> option from <code>pre-commit install</code> so repos without a config will be skipped: <div class="highlight console"><pre>$ git init sample Initialized empty Git repository in /tmp/sample/.git/ $ cd sample $ git commit --allow-empty -m 'Initial commit' `.pre-commit-config.yaml` config file not found. Skipping `pre-commit`. [main (root-commit) d1b39c1] Initial commit </pre></div> To still require opt-in, but prompt the user to set up pre-commit use a template hook as follows (for example in <code>~/.git-template/hooks/pre-commit</code>). <div class="highlight bash"><pre>#!/usr/bin/env bash if [ -f .pre-commit-config.yaml ]; then echo 'pre-commit configuration detected, but `pre-commit install` was never run' 1>&2 exit 1 fi </pre></div> With this, a forgotten <code>pre-commit install</code> produces an error on commit: <div class="highlight console"><pre>$ git clone -q https://github.com/asottile/pyupgrade $ cd pyupgrade/ $ git commit -m 'foo' pre-commit configuration detected, but `pre-commit install` was never run </pre></div> <h2 id="filtering-files-with-types"> Filtering files with types <a href="#filtering-files-with-types" class="text-decoration-none">¶</a></h2> Filtering with <code>types</code> provides several advantages over traditional filtering with <code>files</code>. <ul> <li>no error-prone regular expressions</li> <li>files can be matched by their shebang (even when extensionless)</li> <li>symlinks / submodules can be easily ignored</li> </ul> <code>types</code> is specified per hook as an array of tags. The tags are discovered through a set of heuristics by the <a href="https://github.com/pre-commit/identify">identify</a> library. <code>identify</code> was chosen as it is a small portable pure python library. Some of the common tags you'll find from identify: <ul> <li><code>file</code></li> <li><code>symlink</code></li> <li><code>directory</code> - in the context of pre-commit this will be a submodule</li> <li><code>executable</code> - whether the file has the executable bit set</li> <li><code>text</code> - whether the file looks like a text file</li> <li><code>binary</code> - whether the file looks like a binary file</li> <li><a href="https://github.com/pre-commit/identify/blob/main/identify/extensions.py">tags by extension / naming convention</a></li> <li><a href="https://github.com/pre-commit/identify/blob/main/identify/interpreters.py">tags by shebang (<code>#!</code>)</a></li> </ul> To discover the type of any file on disk, you can use <code>identify</code>'s cli: <div class="highlight console"><pre>$ identify-cli setup.py ["file", "non-executable", "python", "text"] $ identify-cli some-random-file ["file", "non-executable", "text"] $ identify-cli --filename-only some-random-file; echo $? 1 </pre></div> If a file extension you use is not supported, please <a href="https://github.com/pre-commit/identify">submit a pull request</a>! <code>types</code>, <code>types_or</code>, and <code>files</code> are evaluated together with <code>AND</code> when filtering. Tags within <code>types</code> are also evaluated using <code>AND</code>. Tags within <code>types_or</code> are evaluated using <code>OR</code>. For example: <div class="highlight yaml"><pre> files: ^foo/ types: [file, python] </pre></div> will match a file <code>foo/1.py</code> but will not match <code>setup.py</code>. Another example: <div class="highlight yaml"><pre> files: ^foo/ types_or: [javascript, jsx, ts, tsx] </pre></div> will match any of <code>foo/bar.js</code> / <code>foo/bar.jsx</code> / <code>foo/bar.ts</code> / <code>foo/bar.tsx</code> but not <code>baz.js</code>. If you want to match a file path that isn't included in a <code>type</code> when using an existing hook you'll need to revert back to <code>files</code> only matching by overriding the <code>types</code> setting. Here's an example of using <code>check-json</code> against non-json files: <div class="highlight yaml"><pre> - id: check-json types: [file] # override `types: [json]` files: \.(json|myext)$ </pre></div> Files can also be matched by shebang. With <code>types: python</code>, an <code>exe</code> starting with <code>#!/usr/bin/env python3</code> will also be matched. As with <code>files</code> and <code>exclude</code>, you can also exclude types if necessary using <code>exclude_types</code>. <h2 id="regular-expressions"> Regular expressions <a href="#regular-expressions" class="text-decoration-none">¶</a></h2> The patterns for <code>files</code> and <code>exclude</code> are python <a href="https://docs.python.org/3/library/re.html#regular-expression-syntax">regular expressions</a> and are matched with <a href="https://docs.python.org/3/library/re.html#re.search"><code>re.search</code></a>. As such, you can use any of the features that python regexes support. If you find that your regular expression is becoming unwieldy due to a long list of excluded / included things, you may find a <a href="https://docs.python.org/3/library/re.html#re.VERBOSE">verbose</a> regular expression useful. One can enable this with yaml's multiline literals and the <code>(?x)</code> regex flag. <div class="highlight yaml"><pre># ... - id: my-hook exclude: | (?x)^( path/to/file1.py| path/to/file2.py| path/to/file3.py )$ </pre></div> <h2 id="overriding-language-version"> Overriding language version <a href="#overriding-language-version" class="text-decoration-none">¶</a></h2> Sometimes you only want to run the hooks on a specific version of the language. For each language, they default to using the system installed language (So for example if I’m running <code>python3.7</code> and a hook specifies <code>python</code>, pre-commit will run the hook using <code>python3.7</code>). Sometimes you don’t want the default system installed version so you can override this on a per-hook basis by setting the <a href="#config-language_version"><code>language_version</code></a>. <div class="highlight yaml"><pre>- repo: https://github.com/pre-commit/mirrors-scss-lint rev: v0.54.0 hooks: - id: scss-lint language_version: 2.1.5 </pre></div> This tells pre-commit to use ruby <code>2.1.5</code> to run the <code>scss-lint</code> hook. Valid values for specific languages are listed below: <ul> <li>python: Whatever system installed python interpreters you have. The value of this argument is passed as the <code>-p</code> to <code>virtualenv</code>.<ul> <li>on windows the <a href="https://www.python.org/dev/peps/pep-0394/">pep394</a> name will be translated into a py launcher call for portability. So continue to use names like <code>python3</code> (<code>py -3</code>) or <code>python3.6</code> (<code>py -3.6</code>) even on windows.</li> </ul> </li> <li>node: See <a href="https://github.com/ekalinin/nodeenv#advanced">nodeenv</a>.</li> <li>ruby: See <a href="https://github.com/sstephenson/ruby-build/tree/master/share/ruby-build">ruby-build</a>.</li> <li>rust: <code>language_version</code> is passed to <code>rustup</code></li> <li>new in 3.0.0 golang: use the versions on <a href="https://go.dev/dl/">go.dev/dl</a> such as <code>1.19.5</code></li> </ul> you can set <a href="#top_level-default_language_version"><code>default_language_version</code></a> at the <a href="#pre-commit-configyaml---top-level">top level</a> in your configuration to control the default versions across all hooks of a language. <div class="highlight yaml"><pre>default_language_version: # force all unspecified python hooks to run python3 python: python3 # force all unspecified ruby hooks to run ruby 2.1.5 ruby: 2.1.5 </pre></div> <h2 id="badging-your-repository"> badging your repository <a href="#badging-your-repository" class="text-decoration-none">¶</a></h2> you can add a badge to your repository to show your contributors / users that you use pre-commit! <a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit" alt="pre-commit" class="img-fluid img-thumbnail"></a> <ul> <li>Markdown: <div class="copyable"><div class="highlight md"><pre>[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) </pre></div> </div></li> <li>HTML: <div class="copyable"><div class="highlight html"><pre><a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit" alt="pre-commit" style="max-width:100%;"></a> </pre></div> </div></li> <li>reStructuredText: <div class="copyable"><div class="highlight rst"><pre>.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit :target: https://github.com/pre-commit/pre-commit :alt: pre-commit </pre></div> </div></li> <li>AsciiDoc: <div class="copyable"><div class="highlight"><pre>image:https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit[pre-commit, link=https://github.com/pre-commit/pre-commit] </pre></div> </div></li> </ul> <h2 id="usage-in-continuous-integration"> Usage in continuous integration <a href="#usage-in-continuous-integration" class="text-decoration-none">¶</a></h2> pre-commit can also be used as a tool for continuous integration. For instance, adding <code>pre-commit run --all-files</code> as a CI step will ensure everything stays in tip-top shape. To check only files which have changed, which may be faster, use something like <code>pre-commit run --from-ref origin/HEAD --to-ref HEAD</code> <h2 id="managing-ci-caches"> Managing CI Caches <a href="#managing-ci-caches" class="text-decoration-none">¶</a></h2> <code>pre-commit</code> by default places its repository store in <code>~/.cache/pre-commit</code> -- this can be configured in two ways: <ul> <li><code>PRE_COMMIT_HOME</code>: if set, pre-commit will use that location instead.</li> <li><code>XDG_CACHE_HOME</code>: if set, pre-commit will use <code>$XDG_CACHE_HOME/pre-commit</code> following the <a href="https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG Base Directory Specification</a>.</li> </ul> <h3 id="pre-commitci-example"> pre-commit.ci example <a href="#pre-commitci-example" class="text-decoration-none">¶</a></h3> no additional configuration is needed to run in <a href="https://pre-commit.ci">pre-commit.ci</a>! pre-commit.ci also has the following benefits: <ul> <li>it's faster than other free CI solutions</li> <li>it will autofix pull requests</li> <li>it will periodically autoupdate your configuration</li> </ul> <a href="https://github.com/pre-commit-ci-demo/demo#results"><img src="https://raw.githubusercontent.com/pre-commit-ci-demo/demo/main/img/2020-12-15_noop.svg" alt="pre-commit.ci speed comparison" class="img-fluid img-thumbnail"></a> <h3 id="appveyor-example"> appveyor example <a href="#appveyor-example" class="text-decoration-none">¶</a></h3> <div class="highlight yaml"><pre>cache: - '%USERPROFILE%\.cache\pre-commit' </pre></div> <h3 id="azure-pipelines-example"> azure pipelines example <a href="#azure-pipelines-example" class="text-decoration-none">¶</a></h3> note: azure pipelines uses immutable caches so the python version and <code>.pre-commit-config.yaml</code> hash must be included in the cache key. for a repository template, see <a href="https://github.com/asottile/azure-pipeline-templates/blob/main/job--pre-commit.yml">[email protected]</a>. <div class="highlight yaml"><pre>jobs: - job: precommit # ... variables: PRE_COMMIT_HOME: $(Pipeline.Workspace)/pre-commit-cache steps: # ... - script: echo "##vso[task.setvariable variable=PY]$(python -VV)" - task: CacheBeta@0 inputs: key: pre-commit | .pre-commit-config.yaml | "$(PY)" path: $(PRE_COMMIT_HOME) </pre></div> <h3 id="circleci-example"> circleci example <a href="#circleci-example" class="text-decoration-none">¶</a></h3> like <a href="#azure-pipelines-example">azure pipelines</a>, circleci also uses immutable caches: <div class="highlight yaml"><pre> steps: - run: command: | cp .pre-commit-config.yaml pre-commit-cache-key.txt python --version --version >> pre-commit-cache-key.txt - restore_cache: keys: - v1-pc-cache-{{ checksum "pre-commit-cache-key.txt" }} # ... - save_cache: key: v1-pc-cache-{{ checksum "pre-commit-cache-key.txt" }} paths: - ~/.cache/pre-commit </pre></div> (source: <a href="https://github.com/Unity-Technologies/ml-agents/pull/3094/files#diff-1d37e48f9ceff6d8030570cd36286a61">@chriselion</a>) <h3 id="github-actions-example"> github actions example <a href="#github-actions-example" class="text-decoration-none">¶</a></h3> see the <a href="https://github.com/pre-commit/action">official pre-commit github action</a> like <a href="#azure-pipelines-example">azure pipelines</a>, github actions also uses immutable caches: <div class="highlight yaml"><pre> - name: set PY run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV - uses: actions/cache@v3 with: path: ~/.cache/pre-commit key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }} </pre></div> <h3 id="gitlab-ci-example"> gitlab CI example <a href="#gitlab-ci-example" class="text-decoration-none">¶</a></h3> See the <a href="https://docs.gitlab.com/ee/ci/caching/#good-caching-practices">Gitlab caching best practices</a> to fine tune the cache scope. <div class="highlight yaml"><pre>my_job: variables: PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit cache: paths: - ${PRE_COMMIT_HOME} </pre></div> pre-commit's cache requires to be served from a constant location between the different builds. This isn't the default when using k8s runners on GitLab. In case you face the error <code>InvalidManifestError</code>, set <code>builds_dir</code> to something static e.g <code>builds_dir = "/builds"</code> in your <code>[[runner]]</code> config <h3 id="travis-ci-example"> travis-ci example <a href="#travis-ci-example" class="text-decoration-none">¶</a></h3> <div class="highlight yaml"><pre>cache: directories: - $HOME/.cache/pre-commit </pre></div> <h2 id="usage-with-tox"> Usage with tox <a href="#usage-with-tox" class="text-decoration-none">¶</a></h2> <a href="https://tox.readthedocs.io/">tox</a> is useful for configuring test / CI tools such as pre-commit. One feature of <code>tox>=2</code> is it will clear environment variables such that tests are more reproducible. Under some conditions, pre-commit requires a few environment variables and so they must be allowed to be passed through. When cloning repos over ssh (<code>repo: <a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="8cebe5f8ccebe5f8e4f9eea2efe3e1">[email protected]</a>:...</code>), <code>git</code> requires the <code>SSH_AUTH_SOCK</code> variable and will otherwise fail: <div class="highlight pre-commit"><pre>[INFO] Initializing environment for <a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="15727c6155727c617d60773b767a78">[email protected]</a>:pre-commit/pre-commit-hooks. An unexpected error has occurred: CalledProcessError: command: ('/usr/bin/git', 'fetch', 'origin', '--tags') return code: 128 expected return code: 0 stdout: (none) stderr: <a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="d1b6b8a591b6b8a5b9a4b3ffb2bebc">[email protected]</a>: Permission denied (publickey). fatal: Could not read from remote repository. Please make sure you have the correct access rights and the repository exists. Check the log at /home/asottile/.cache/pre-commit/pre-commit.log </pre></div> Add the following to your tox testenv: <div class="highlight ini"><pre>[testenv] passenv = SSH_AUTH_SOCK </pre></div> Likewise, when cloning repos over http / https (<code>repo: https://github.com:...</code>), you might be working behind a corporate http(s) proxy server, in which case <code>git</code> requires the <code>http_proxy</code>, <code>https_proxy</code> and <code>no_proxy</code> variables to be set, or the clone may fail: <div class="highlight ini"><pre>[testenv] passenv = http_proxy https_proxy no_proxy </pre></div> <h2 id="using-the-latest-version-for-a-repository"> Using the latest version for a repository <a href="#using-the-latest-version-for-a-repository" class="text-decoration-none">¶</a></h2> <code>pre-commit</code> configuration aims to give a repeatable and fast experience and therefore intentionally doesn't provide facilities for "unpinned latest version" for hook repositories. Instead, <code>pre-commit</code> provides tools to make it easy to upgrade to the latest versions with <a href="#pre-commit-autoupdate"><code>pre-commit autoupdate</code></a>. If you need the absolute latest version of a hook (instead of the latest tagged version), pass the <code>--bleeding-edge</code> parameter to <code>autoupdate</code>. <code>pre-commit</code> assumes that the value of <a href="#repos-rev"><code>rev</code></a> is an immutable ref (such as a tag or SHA) and will cache based on that. Using a branch name (or <code>HEAD</code>) for the value of <a href="#repos-rev"><code>rev</code></a> is not supported and will only represent the state of that mutable ref at the time of hook installation (and will NOT update automatically). </div> <div id="contributing"> <div class="page-header"><h1 id="contributing"> Contributing <a href="#contributing" class="text-decoration-none">¶</a></h1> </div> We’re looking to grow the project and get more contributors especially to support more languages/versions. We’d also like to get the .pre-commit-hooks.yaml files added to popular linters without maintaining forks / mirrors. Feel free to submit bug reports, pull requests, and feature requests. <h2 id="sponsoring"> Sponsoring <a href="#sponsoring" class="text-decoration-none">¶</a></h2> If you or your company would like to support the development of pre-commit one can contribute in the following ways: <ul> <li><a href="https://github.com/sponsors/asottile">GitHub Sponsors (asottile)</a></li> <li><a href="https://opencollective.com/pre-commit">Open Collective</a></li> </ul> <h2 id="getting-help"> Getting help <a href="#getting-help" class="text-decoration-none">¶</a></h2> There are several ways to get help for pre-commit: <ul> <li>Ask a question on <a href="https://stackoverflow.com/questions/tagged/pre-commit.com">stackoverflow tagged <kbd>pre-commit.com</kbd></a></li> <li>Create an issue on <a href="https://github.com/pre-commit/pre-commit/issues/">pre-commit/pre-commit</a></li> <li>Ask in the #pre-commit channel in <a href="https://discord.gg/xDKGPaW">asottile's twitch discord</a></li> </ul> <h2 id="contributors"> Contributors <a href="#contributors" class="text-decoration-none">¶</a></h2> <ul> <li>website by <a href="https://github.com/mfnkl">Molly Finkle</a></li> <li>created by <a href="https://github.com/asottile">Anthony Sottile</a></li> <li>core developers: <a href="https://github.com/struys">Ken Struys</a>, <a href="https://github.com/chriskuehl">Chris Kuehl</a></li> <li><a href="https://github.com/pre-commit/pre-commit/graphs/contributors">framework contributors</a></li> <li><a href="https://github.com/pre-commit/pre-commit-hooks/graphs/contributors">core hook contributors</a></li> <li>and users like you!</li> </ul> </div> </div> </div> </main> <footer class="navbar navbar-expand navbar-dark bg-primary"> <div class="container-md"> </div> </footer> <script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script><script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-104682927-1', 'auto'); ga('send', 'pageview'); </script> <script src="assets/copyable.js"></script> </body> </html>