Skip to content

Commit 4fe55b4

Browse files
Deployed to github pages
1 parent 0c805fd commit 4fe55b4

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

hooks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ <h2 id="adding-to-this-page"> adding to this page <small><a href="#adding-to-
149149
requirements you <em>must</em> follow or your PR will be closed without comment:</p>
150150
<ul>
151151
<li>the tool must already be fairly popular (&gt;500 stars)</li>
152-
<li>the tool must use a managed language (no <code>system</code> / <code>script</code> / <code>docker</code> hooks)</li>
152+
<li>the tool must use a managed language (no <code>unsupported</code> / <code>unsupported_script</code> / <code>docker</code> hooks)</li>
153153
<li>the tool must operate on files</li>
154154
</ul>
155155

index.html

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ <h2 id="quick-start"> Quick start <small><a href="#quick-start" class="text-d
134134
<li><code>pre-commit --version</code> should show you what version you're using</li>
135135
</ul>
136136
<div class="highlight pre-commit"><pre><span></span>$ pre-commit --version
137-
pre-commit 4.3.0
137+
pre-commit 4.4.0
138138
</pre></div>
139139
<h3 id="2-add-a-pre-commit-configuration"> 2. Add a pre-commit configuration <small><a href="#2-add-a-pre-commit-configuration" class="text-decoration-none"></a></small></h3> <ul>
140140
<li>create a file named <code>.pre-commit-config.yaml</code></li>
@@ -468,8 +468,8 @@ <h2 id="supported-languages"> Supported languages <small><a href="#supported-
468468
<li><a href="#rust">rust</a></li>
469469
<li><a href="#swift">swift</a></li>
470470
<li><a href="#pygrep">pygrep</a></li>
471-
<li><a href="#script">script</a></li>
472-
<li><a href="#system">system</a></li>
471+
<li><a href="#unsupported">unsupported</a></li>
472+
<li><a href="#unsupported_scripts">unsupported_script</a></li>
473473
</ul>
474474
<h3 id="conda"> conda <small><a href="#conda" class="text-decoration-none"></a></small></h3> <p>The hook repository must contain an <code>environment.yml</code> file which will be used
475475
via <code>conda env create --file environment.yml ...</code> to create the environment.</p>
@@ -688,17 +688,21 @@ <h3 id="pygrep"> pygrep <small><a href="#pygrep" class="text-decoration-none"
688688
<p>To require all files to match, use <code>args: [--negate]</code>.</p>
689689
<p><strong>Support:</strong> pygrep hooks are supported on all platforms which pre-commit runs
690690
on.</p>
691-
<h3 id="script"> script <small><a href="#script" class="text-decoration-none"></a></small></h3> <p>Script hooks provide a way to write simple scripts which validate files. The
692-
<a href="#hooks-entry"><code>entry</code></a> should be a path relative to the root of the hook repository.</p>
693-
<p>This hook type will not be given a virtual environment to work with – if it
694-
needs additional dependencies the consumer must install them manually.</p>
695-
<p><strong>Support:</strong> the support of script hooks depend on the scripts themselves.</p>
696-
<h3 id="system"> system <small><a href="#system" class="text-decoration-none"></a></small></h3> <p>System hooks provide a way to write hooks for system-level executables which
691+
<h3 id="unsupported"> unsupported <small><a href="#unsupported" class="text-decoration-none"></a></small></h3> <p><a name="system"></a>
692+
<em>new in 4.4.0</em>: previously <code>language: system</code>. the alias will be removed in a
693+
future version</p>
694+
<p>System hooks provide a way to write hooks for system-level executables which
697695
don't have a supported language above (or have special environment
698696
requirements that don't allow them to run in isolation such as pylint).</p>
699697
<p>This hook type will not be given a virtual environment to work with – if it
700698
needs additional dependencies the consumer must install them manually.</p>
701-
<p><strong>Support:</strong> the support of system hooks depend on the executables.</p>
699+
<h3 id="unsupported_script"> unsupported_script <small><a href="#unsupported_script" class="text-decoration-none"></a></small></h3> <p><a name="script"></a>
700+
<em>new in 4.4.0</em>: previously <code>language: script</code>. the alias will be removed in a
701+
future version</p>
702+
<p>Script hooks provide a way to write simple scripts which validate files. The
703+
<a href="#hooks-entry"><code>entry</code></a> should be a path relative to the root of the hook repository.</p>
704+
<p>This hook type will not be given a virtual environment to work with – if it
705+
needs additional dependencies the consumer must install them manually.</p>
702706

703707
</div>
704708
<div id="cli">
@@ -1069,7 +1073,7 @@ <h3 id="arguments-pattern-in-hooks"> Arguments pattern in hooks <small><a hre
10691073
<span class="w"> </span><span class="nt">hooks</span><span class="p">:</span>
10701074
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">check-requirements</span>
10711075
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">check requirements files</span>
1072-
<span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">system</span>
1076+
<span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unsupported</span>
10731077
<span class="w"> </span><span class="nt">entry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python -m scripts.check_requirements --compare</span>
10741078
<span class="w"> </span><span class="nt">files</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">^requirements.*\.txt$</span>
10751079
</pre></div>
@@ -1084,7 +1088,7 @@ <h2 id="repository-local-hooks"> Repository local hooks <small><a href="#repo
10841088
<p>You can configure repository-local hooks by specifying the <a href="#repos-repo"><code>repo</code></a> as the
10851089
sentinel <code>local</code>.</p>
10861090
<p>local hooks can use any language which supports <a href="#config-additional_dependencies"><code>additional_dependencies</code></a>
1087-
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>.
1091+
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="#unsupported"><code>unsupported</code></a> / <a href="#unsupported_script"><code>unsupported_script</code></a>.
10881092
This enables you to install things which previously would require a trivial
10891093
mirror repository.</p>
10901094
<p>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>,
@@ -1096,13 +1100,13 @@ <h2 id="repository-local-hooks"> Repository local hooks <small><a href="#repo
10961100
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pylint</span>
10971101
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pylint</span>
10981102
<span class="w"> </span><span class="nt">entry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pylint</span>
1099-
<span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">system</span>
1103+
<span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unsupported</span>
11001104
<span class="w"> </span><span class="nt">types</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">python</span><span class="p p-Indicator">]</span>
11011105
<span class="w"> </span><span class="nt">require_serial</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
11021106
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">check-x</span>
11031107
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Check X</span>
11041108
<span class="w"> </span><span class="nt">entry</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./bin/check-x.sh</span>
1105-
<span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">script</span>
1109+
<span class="w"> </span><span class="nt">language</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">unsupported_script</span>
11061110
<span class="w"> </span><span class="nt">files</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">\.x$</span>
11071111
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">scss-lint</span>
11081112
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">scss-lint</span>

0 commit comments

Comments
 (0)