git-hook-installer 3.0.1

Install basic premade git hooks into the current repository.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# git-hook-installer

A small Rust CLI that installs premade git hooks into the **current** repository.

[![crates.io](https://img.shields.io/crates/v/git-hook-installer.svg)](https://crates.io/crates/git-hook-installer)
[![Downloads](https://img.shields.io/crates/d/git-hook-installer.svg)](https://crates.io/crates/git-hook-installer)
[![docs.rs](https://img.shields.io/docsrs/git-hook-installer)](https://docs.rs/git-hook-installer)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Rust](https://img.shields.io/badge/rust-stable-orange.svg)](https://www.rust-lang.org/)
[![dependency status](https://deps.rs/repo/github/pRizz/git-hook-installer/status.svg)](https://deps.rs/repo/github/pRizz/git-hook-installer)

## Install

From [crates.io](https://crates.io/crates/git-hook-installer):

```bash
cargo install git-hook-installer
```

Or from source (this repo):

```bash
cargo install --path .
```

## Usage

Run with no arguments to offer to install/update the managed `pre-commit` hook:

```bash
git-hook-installer
```

Recursively install/update the managed `pre-commit` hook across many repos under a directory:

```bash
# scans current directory
git-hook-installer install-recursive

# or pass an explicit directory to scan
git-hook-installer install-recursive ~/src

# increase scan depth (default is 1)
git-hook-installer install-recursive --max-depth 3 ~/src

# skip the confirmation prompt
git-hook-installer --yes install-recursive ~/src
```

Inspect the current hook state:

```bash
git-hook-installer status
```

Install/update the managed `pre-commit` hook directly:

```bash
git-hook-installer install pre-commit
```

Disable the managed `pre-commit` block (without removing it):

```bash
git-hook-installer disable
```

Uninstall the managed `pre-commit` block (preserves any other pre-commit logic you already had):

```bash
git-hook-installer uninstall
```

If your repo has multiple `Cargo.toml` files (monorepo), pick which one the hook should use:

```bash
git-hook-installer install pre-commit --manifest-dir crates/my-crate
```

## Behavior

- **git repo detection**: walks up parent directories looking for `.git` (supports worktrees where `.git` is a file).
- **recursive install**: `install-recursive [DIR]` scans for git repos under a directory and runs the installer in each repo (shows a count + directory preview and asks for confirmation unless `--yes`). The default scan depth is **1**, configurable via `--max-depth`.
- **safe overwrites**: if a hook already exists, it will prompt before backing it up (or use `--force` / `--yes`).
- **hook installed**: `.git/hooks/pre-commit` contains a **managed block** (marked with `git-hook-installer` begin/end markers) which can run a set of formatters/linters and **re-stage** changes.
- **no repo config**: all settings are stored **inside the hook file in `.git/hooks/`** (nothing is written to your repository).
- **proof-based language enabling (to avoid surprises)**:
  - At install time, `git-hook-installer` tries to determine which languages your repo actually uses.
  - The generated hook only includes language sections when there is **positive evidence** (“proof”) that the repo uses that language. This prevents, for example, adding JS/TS lints to a non-JS repo.
  - If you later add a new language to the repo (or add config files), re-run `git-hook-installer install pre-commit` to re-detect and regenerate the hook.
  - Monorepos are supported: detection includes a **bounded shallow scan** so nested packages can still be detected without doing an expensive full repo walk.
- **toolchain auto-selection**:
  - For languages that are enabled (proven), the installer auto-selects the most likely toolchain (e.g. Biome vs Prettier+ESLint, Ruff vs Black, Spotless vs ktlint) based on common config signals.
  - In interactive installs it prints a short “auto-selected/defaulting” summary; in `--non-interactive` mode it stays quiet.
- **what counts as “proof”** (high-level):
  - **JS/TS**: `package.json` / lockfiles / `tsconfig.json` / `jsconfig.json` / Biome / ESLint / Prettier config, or a shallow scan that finds JS/TS source files.
    - Note: Prettier-based formatting for **Markdown/YAML** is tied to JS/TS being enabled (since it uses the same toolchain).
    - If the repo is detected as **TypeScript**, the hook also runs a **`tsc --noEmit` typecheck** when staged changes include `*.ts/*.tsx` or `tsconfig.json` (uses `tsc` on PATH or `npx --yes tsc`).
  - **Python**: `pyproject.toml`, requirements/setup files, common lockfiles, or a shallow scan that finds `.py` files.
  - **Java/Kotlin**: Gradle/Maven files, or a shallow scan that finds `.java/.kt/.kts` files.
  - **Go**: `go.mod/go.work/go.sum`, or a shallow scan that finds `.go` files.
  - **Ruby**: `Gemfile` / `.ruby-version` / `Rakefile`, or a shallow scan that finds `.rb` files.
  - **Shell**: `.shellcheckrc` / `.shfmt`, or a shallow scan that finds shell scripts.
  - **Terraform**: `.terraform.lock.hcl`, or a shallow scan that finds `.tf/.tfvars` files.
  - **C/C++**: `.clang-format`, or a shallow scan that finds common C/C++ file extensions.
  - **Rust**: `cargo fmt` only runs when a Cargo manifest directory was resolved (or passed via `--manifest-dir`).
- **auto-fix safety**:
  - If you have **unstaged/untracked** changes, the hook stashes them with `git stash push --keep-index --include-untracked`, runs auto-fix on the staged files, re-stages, and then restores the stash.
  - If a formatting step errors, the hook attempts a **best-effort rollback** (reset + re-apply saved staged diff, plus stash restore if used).
- **snapshots before edits**: before `git-hook-installer` modifies `.git/hooks/pre-commit`, it snapshots the current file to `.git/hooks/pre-commit.snapshot-YYYY-MM-DD-HH-MM-SS` and keeps the newest **10** snapshots by default.

## Options

- `-y, --yes`: auto-confirm prompts
- `--non-interactive`: never prompt (fails on ambiguity or existing hooks unless `--force`)
- `-f, --force`: overwrite existing hook (backs it up first)

## Links

- [Repository](https://github.com/pRizz/git-hook-installer)
- [Crates.io](https://crates.io/crates/git-hook-installer)
- [Documentation](https://docs.rs/git-hook-installer)