lefthook

This repo contains a collection of reusable lefthook configuration files for various languages and tools.

Usage

In order to use any of the hooks in this repo, please do the following:

1. Install lefthook.

2. In the root directory of your git repo, use lefthook install to create a lefthook.yml file.

3. Edit the file to include the hooks from this repo that you want:

   remotes:
     - git_url: <https://github.com/AjayKMehta/lefthook.git>
         configs:
           - hooks/pre-commit/<hook1>
           - hooks/pre-commit/<hook2>
           - hooks/pre-push/<hook1>

   💡 All the hooks are located in hooks/<hook-type>/<hook>.

4. Install dependencies for any hooks of interest (see next section for details).

5. Run lefthook install to install these hooks in your repo. You can use lefthook check-install and lefthook dump to verify everything is installed and configured correctly.

Available Hooks

commit-msg

• run-commitlint.yml: Requires commitlint to be installed.
• run-typos.yml: Uses typos to spellcheck commit messages.

post-checkout

• dotnet-clean.yml: Run dotnet clean after checkout.

post-merge

• restore-nuget.yml: Restore NuGet packages if any lock file changes.

pre-commit

• analyze-csharp.yml: This uses dotnet format to run analyzers on staged C# files.
• format-csharp.yml: This uses dotnet format to check formatting of staged C# files.
• lint-actions.yml: This requires actionlint to be installed.
• lint-docker.yml: This requires hadolint to be installed.
• lint-json.yml: This requires jsonlint to be installed. It removes duplicate keys and pretty prints JSON files.
• lint-markdown.yml: This requires markdownlint-cli2 to be installed.
• lint-toml.yml: This requires taplo to be installed.
• lint-vscode.yml: This requires jsonlint to be installed. It removes duplicate keys and sorts settings.json.
• lint-yaml.yml: This requires yamllint to be installed.

pre-push

• detect-secrets.yml: This requires gitleaks to be installed.

• test-dotnet.yml:

  • This ensures .NET code builds and all tests run successfully.

  • You can override the default build configuration (Release) by adding this to your repo's lefthook-local.yml:

    templates:
      build_config: <New value>

  👉 Assumes that there is a solution file at repo root.