89 lines
2.8 KiB
Markdown
89 lines
2.8 KiB
Markdown
---
|
|
source_keys:
|
|
- context7-pre-commit-com
|
|
- pre-commit-com
|
|
---
|
|
|
|
# Hook Failure Patterns
|
|
|
|
Common hook failure causes and concrete next-step suggestions.
|
|
|
|
## Hook modified files — commit blocked
|
|
|
|
Cause: A fixer hook (e.g. `trailing-whitespace`, `end-of-file-fixer`, `pretty-format-json`) modified staged files. The commit is blocked because the staged version is now stale.
|
|
|
|
Fix: Re-stage and recommit.
|
|
```bash
|
|
git add -u
|
|
git commit -m "same message"
|
|
```
|
|
|
|
## Secret detected (gitleaks)
|
|
|
|
Cause: gitleaks found a high-entropy string or known secret pattern in a staged file.
|
|
|
|
Suggestions:
|
|
- If it's a false positive: add a `# gitleaks:allow` inline comment, or add the path to `.gitleaksignore`.
|
|
- If it's a real secret: remove it from the file, rotate the credential, then commit.
|
|
|
|
## Shellcheck warning
|
|
|
|
Cause: shellcheck found a shell script issue. The output includes the file path, line number, and SC-code.
|
|
|
|
Fix: Look up the SC-code on shellcheck.net or pass `--explain SCxxxx` to shellcheck for a detailed explanation. The most common fixes:
|
|
- SC2086 (unquoted variable): wrap in double quotes.
|
|
- SC2046 (unquoted command substitution): wrap in double quotes.
|
|
- SC2181 (check exit code of `$?`): use `if command; then` directly.
|
|
|
|
## pretty-format-json fails but doesn't fix
|
|
|
|
Cause: `pretty-format-json` requires `args: [--autofix]` to modify files. Without it, the hook only fails.
|
|
|
|
Fix: The user (or `pc-author`) must add `args: [--autofix]` to the hook override in `.pre-commit-config.yaml`.
|
|
|
|
## Environment stale or broken
|
|
|
|
Cause: A hook's cached environment is corrupted or out of date.
|
|
|
|
Fix:
|
|
```bash
|
|
pre-commit clean # wipe all environments
|
|
pre-commit install-hooks # rebuild everything
|
|
```
|
|
|
|
Or less destructively:
|
|
```bash
|
|
pre-commit gc # remove only unused environments
|
|
```
|
|
|
|
## Hooks don't run on `git commit`
|
|
|
|
Cause: `pre-commit install` was never run in this clone.
|
|
|
|
Fix: `pre-commit install`. Git hooks are per-clone — they are not committed to the repo.
|
|
|
|
## Hook runs but matches wrong files (or no files)
|
|
|
|
Cause: The `files:` pattern uses `re.search()` not full-string match. A pattern that looks correct may match unexpectedly.
|
|
|
|
Diagnosis: `identify-cli <filename>` shows the type tags for a file. Verify `types:` filters against these.
|
|
|
|
## stages mismatch — hook never fires
|
|
|
|
Cause: Hook is defined for a stage (e.g. `pre-push`) but `pre-commit install` was not run with `-t pre-push`.
|
|
|
|
Fix:
|
|
```bash
|
|
pre-commit install -t pre-commit -t pre-push -t commit-msg
|
|
```
|
|
|
|
Or add `default_install_hook_types` to `.pre-commit-config.yaml` and re-run `pre-commit install`.
|
|
|
|
## `validate-config` schema error
|
|
|
|
Common causes:
|
|
- Missing `id` under a hook block
|
|
- Missing `rev` under a non-local repo block
|
|
- `repo: local` hook missing `language` or `entry`
|
|
- Indentation error (valid YAML but invalid pre-commit schema)
|