Skip to content

Commit

Permalink
deploy: 3e3f880
Browse files Browse the repository at this point in the history
  • Loading branch information
mrexox committed Jan 10, 2025
1 parent e737e12 commit 82e03a9
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 2 deletions.
16 changes: 16 additions & 0 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,8 @@ <h1 id="introduction"><a class="header" href="#introduction">Introduction</a></h
<li><a href="usage/./commands.html#lefthook-run"><code>lefthook run</code></a></li>
<li><a href="usage/./commands.html#lefthook-version"><code>lefthook version</code></a></li>
<li><a href="usage/./commands.html#lefthook-self-update"><code>lefthook self-update</code></a></li>
<li><a href="usage/./commands.html#lefthook-validate"><code>lefthook validate</code></a></li>
<li><a href="usage/./commands.html#lefthook-dump"><code>lefthook dump</code></a></li>
</ul>
</li>
<li><a href="usage/./env.html">ENV variables</a>
Expand Down Expand Up @@ -329,6 +331,16 @@ <h1 id="introduction"><a class="header" href="#introduction">Introduction</a></h
<blockquote>
<p><strong>Tip:</strong> Use <code>lefthook help</code> or <code>lefthook &lt;command&gt; -h/--help</code> to discover available commands and their options</p>
</blockquote>
<ul>
<li><a href="usage/commands.html#lefthook-install"><code>lefthook install</code></a></li>
<li><a href="usage/commands.html#lefthook-uninstall"><code>lefthook uninstall</code></a></li>
<li><a href="usage/commands.html#lefthook-add"><code>lefthook add</code></a></li>
<li><a href="usage/commands.html#lefthook-run"><code>lefthook run</code></a></li>
<li><a href="usage/commands.html#lefthook-version"><code>lefthook version</code></a></li>
<li><a href="usage/commands.html#lefthook-self-update"><code>lefthook self-update</code></a></li>
<li><a href="usage/commands.html#lefthook-validate"><code>lefthook validate</code></a></li>
<li><a href="usage/commands.html#lefthook-dump"><code>lefthook dump</code></a></li>
</ul>
<h3 id="lefthook-install"><a class="header" href="#lefthook-install"><code>lefthook install</code></a></h3>
<p><code>lefthook install</code> creates an empty <code>lefthook.yml</code> if a configuration file does not exist and updates git hooks to use lefthook. Run <code>lefthook install</code> after cloning the git repo.</p>
<blockquote>
Expand Down Expand Up @@ -397,6 +409,10 @@ <h3 id="lefthook-version"><a class="header" href="#lefthook-version"><code>lefth
</code></pre>
<h3 id="lefthook-self-update"><a class="header" href="#lefthook-self-update"><code>lefthook self-update</code></a></h3>
<p><code>lefthook self-update</code> updates the binary with the latest lefthook release on Github. This command is available only if you install lefthook from sources or download the binary from the Github Releases. For other ways use package-specific commands to update lefthook.</p>
<h3 id="lefthook-validate"><a class="header" href="#lefthook-validate"><code>lefthook validate</code></a></h3>
<p><code>lefthook validate</code> loads JSON schema from the Github repo and validates you main lefthook config (e.g. <code>lefthook.yml</code>) and secondary configs (<code>lefthook-local.yml</code>, configs from <code>extends</code> and <code>remotes</code>). Use <code>lefthook dump</code> to get the full config and locate the issue.</p>
<h3 id="lefthook-dump"><a class="header" href="#lefthook-dump"><code>lefthook dump</code></a></h3>
<p><code>lefthook dump</code> prints the merged config. This is the actual config lefthook uses, it can be build from the main config (<code>lefthook.yml</code>), remotes, extends, and <code>lefthook-local.yml</code> overrides.</p>
<div style="break-before: page; page-break-before: always;"></div><h2 id="env-variables"><a class="header" href="#env-variables">ENV variables</a></h2>
<blockquote>
<p>ENV variables control some lefthook behavior. Most of them have the alternative CLI or config options.</p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions usage/commands.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,16 @@ <h2 id="commands"><a class="header" href="#commands">Commands</a></h2>
<blockquote>
<p><strong>Tip:</strong> Use <code>lefthook help</code> or <code>lefthook &lt;command&gt; -h/--help</code> to discover available commands and their options</p>
</blockquote>
<ul>
<li><a href="#lefthook-install"><code>lefthook install</code></a></li>
<li><a href="#lefthook-uninstall"><code>lefthook uninstall</code></a></li>
<li><a href="#lefthook-add"><code>lefthook add</code></a></li>
<li><a href="#lefthook-run"><code>lefthook run</code></a></li>
<li><a href="#lefthook-version"><code>lefthook version</code></a></li>
<li><a href="#lefthook-self-update"><code>lefthook self-update</code></a></li>
<li><a href="#lefthook-validate"><code>lefthook validate</code></a></li>
<li><a href="#lefthook-dump"><code>lefthook dump</code></a></li>
</ul>
<h3 id="lefthook-install"><a class="header" href="#lefthook-install"><code>lefthook install</code></a></h3>
<p><code>lefthook install</code> creates an empty <code>lefthook.yml</code> if a configuration file does not exist and updates git hooks to use lefthook. Run <code>lefthook install</code> after cloning the git repo.</p>
<blockquote>
Expand Down Expand Up @@ -227,6 +237,10 @@ <h3 id="lefthook-version"><a class="header" href="#lefthook-version"><code>lefth
</code></pre>
<h3 id="lefthook-self-update"><a class="header" href="#lefthook-self-update"><code>lefthook self-update</code></a></h3>
<p><code>lefthook self-update</code> updates the binary with the latest lefthook release on Github. This command is available only if you install lefthook from sources or download the binary from the Github Releases. For other ways use package-specific commands to update lefthook.</p>
<h3 id="lefthook-validate"><a class="header" href="#lefthook-validate"><code>lefthook validate</code></a></h3>
<p><code>lefthook validate</code> loads JSON schema from the Github repo and validates you main lefthook config (e.g. <code>lefthook.yml</code>) and secondary configs (<code>lefthook-local.yml</code>, configs from <code>extends</code> and <code>remotes</code>). Use <code>lefthook dump</code> to get the full config and locate the issue.</p>
<h3 id="lefthook-dump"><a class="header" href="#lefthook-dump"><code>lefthook dump</code></a></h3>
<p><code>lefthook dump</code> prints the merged config. This is the actual config lefthook uses, it can be build from the main config (<code>lefthook.yml</code>), remotes, extends, and <code>lefthook-local.yml</code> overrides.</p>

</main>

Expand Down
2 changes: 2 additions & 0 deletions usage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,8 @@ <h1 id="usage"><a class="header" href="#usage">Usage</a></h1>
<li><a href="./commands.html#lefthook-run"><code>lefthook run</code></a></li>
<li><a href="./commands.html#lefthook-version"><code>lefthook version</code></a></li>
<li><a href="./commands.html#lefthook-self-update"><code>lefthook self-update</code></a></li>
<li><a href="./commands.html#lefthook-validate"><code>lefthook validate</code></a></li>
<li><a href="./commands.html#lefthook-dump"><code>lefthook dump</code></a></li>
</ul>
</li>
<li><a href="./env.html">ENV variables</a>
Expand Down

0 comments on commit 82e03a9

Please sign in to comment.