Skip to content

Commit 9307489

Browse files
Deployed to github pages
1 parent 60bce10 commit 9307489

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

index.html

Lines changed: 30 additions & 1 deletion
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.0.1
137+
pre-commit 4.1.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>
@@ -582,6 +582,35 @@ <h3 id="haskell"> haskell <small><a href="#haskell" class="text-decoration-no
582582
<code>repo: local</code> hook.</p>
583583
<p><strong>Support:</strong> haskell hooks are known to work on any system which has <code>cabal</code>
584584
installed. It has been tested on linux, macOS, and windows.</p>
585+
<h3 id="julia"> julia <small><a href="#julia" class="text-decoration-none"></a></small></h3> <p><em>new in 4.1.0</em></p>
586+
<p>For configuring julia hooks, your <a href="#hooks-entry"><code>entry</code></a> should be a path to a julia source
587+
file relative to the hook repository (optionally with arguments).</p>
588+
<p>Hooks run in an isolated package environment defined by a <code>Project.toml</code> file (optionally
589+
with a <code>Manifest.toml</code> file) in the hook repository. If no <code>Project.toml</code> file is found the
590+
hook is run in an empty environment.</p>
591+
<p>Julia hooks support <a href="#config-additional_dependencies"><code>additional_dependencies</code></a> which can
592+
be used to augment, or override, the existing environment in the hooks repository. This also
593+
means that julia can be used as a <code>repo: local</code> hook. <code>additional_dependencies</code> are passed
594+
to <code>pkg&gt; add</code> and should be specified using
595+
<a href="https://pkgdocs.julialang.org/v1/repl/#repl-add">Pkg REPL mode syntax</a>.</p>
596+
<p>Examples:</p>
597+
<div class="highlight yaml"><pre><span></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">foo-without-args</span>
598+
<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">...</span>
599+
<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">julia</span>
600+
<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/foo.jl</span>
601+
<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">bar-with-args</span>
602+
<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">...</span>
603+
<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">julia</span>
604+
<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/bar.jl --arg1 --arg2</span>
605+
<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">baz-with-extra-deps</span>
606+
<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">...</span>
607+
<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">julia</span>
608+
<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/baz.jl</span>
609+
<span class="w"> </span><span class="nt">additional_dependencies</span><span class="p">:</span>
610+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;ExtraDepA@1&#39;</span>
611+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;[email protected]&#39;</span>
612+
</pre></div>
613+
<p><strong>Support:</strong> julia hooks are known to work on any system which has <code>julia</code> installed.</p>
585614
<h3 id="lua"> lua <small><a href="#lua" class="text-decoration-none"></a></small></h3> <p>Lua hooks are installed with the version of Lua that is used by Luarocks.</p>
586615
<p><strong>Support:</strong> Lua hooks are known to work on any system which has Luarocks
587616
installed. It has been tested on linux and macOS and <em>may</em> work on windows.</p>

0 commit comments

Comments
 (0)