AGENT SKILL

setup-pre-commit

Set up Husky pre-commit hooks with lint-staged (Prettier), type checking, and the repository lint (which includes `development-system check-no-tests`) in the current repo; the hook never runs automated tests. Use when user wants to add pre-commit hooks, set up Husky, configure lint-staged, or add commit-time formatting/typechecking/linting.

License 许可
MIT
最近更新
2026-11-14
Stars
★ 0
Forks
0

01 前言 Front Matter

name
setup-pre-commit
description
Set up Husky pre-commit hooks with lint-staged (Prettier), type checking, and the repository lint (which includes `development-system check-no-tests`) in the current repo; the hook never runs automated tests. Use when user wants to add pre-commit hooks, set up Husky, configure lint-staged, or add commit-time formatting/typechecking/linting.

02 资源文件 1

03 SKILL.md 正文

Setup Pre-Commit Hooks

What This Sets Up

  • Husky pre-commit hook
  • lint-staged running Prettier on all staged files
  • Prettier config (if missing)
  • typecheck and lint scripts in the pre-commit hook (the lint includes development-system check-no-tests; the hook never runs automated tests)

Steps

1. Detect package manager

Check for package-lock.json (npm), pnpm-lock.yaml (pnpm), yarn.lock (yarn), bun.lockb (bun). Use whichever is present. Default to npm if unclear.

2. Install dependencies

Install as devDependencies:

husky lint-staged prettier

3. Initialize Husky

npx husky init

This creates .husky/ dir and adds prepare: "husky" to package.json.

4. Create .husky/pre-commit

Write this file (no shebang needed for Husky v9+):

if [ ! -f "$(git rev-parse --git-dir)/MERGE_HEAD" ]; then
  npx lint-staged
fi
npm run typecheck
npm run lint

The hook does not format while a merge is being committed (MERGE_HEAD exists): formatting there rewrites files that came from the other branch, so the merge stops being the clean merge of its two parents and reviews of the branch have to be repeated. Typecheck and lint still run.

Adapt: Replace npm with detected package manager. If repo has no typecheck or lint script in package.json, omit those lines and tell the user.

5. Create .lintstagedrc

{
  "*": "prettier --ignore-unknown --write"
}

6. Create .prettierrc (if missing)

Only create if no Prettier config exists. Use these defaults:

{
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": false,
  "trailingComma": "es5",
  "semi": true,
  "arrowParens": "always"
}

7. Verify

  • [ ] .husky/pre-commit exists, is executable and skips lint-staged when MERGE_HEAD exists
  • [ ] .lintstagedrc exists
  • [ ] prepare script in package.json is "husky"
  • [ ] prettier config exists
  • [ ] Run npx lint-staged to verify it works

8. Commit

Stage all changed/created files and commit with message: Add pre-commit hooks (husky + lint-staged + prettier)

This will run through the new pre-commit hooks: a good smoke check that everything works.

Notes

  • Husky v9+ doesn't need shebangs in hook files
  • prettier --ignore-unknown skips files Prettier can't parse (images, etc.)
  • The pre-commit runs lint-staged first (fast, staged-only; skipped while committing a merge), then full typecheck and the repository lint (which runs development-system check-no-tests); it never runs automated tests

04 同仓库更多 Skills