Setup Pre Commit

作者 mattpocockc55ee46073ed无许可证收录于 2026年10月8日更新于 2026年10月8日

Set up Husky pre-commit hooks with lint-staged (Prettier), type checking, and tests in the current repo. Use when user wants to add pre-commit hooks, set up Husky, configure lint-staged, or add commit-time formatting/typechecking/testing.

AI 生成的概览

为代码仓库配置 Husky 预提交钩子,集成 lint-staged、Prettier、类型检查和测试。

功能
该技能指导在仓库中配置提交时检查:检测包管理器,将 husky、lint-staged 和 prettier 安装为开发依赖,并初始化 Husky。它会创建运行 lint-staged 以及 typecheck 和 test 脚本的 .husky/pre-commit 钩子、对暂存文件运行 Prettier 的 .lintstagedrc,以及在不存在的默认 .prettierrc。最后提供验证清单并提交新增文件。
适用场景
当用户想要添加预提交钩子、配置 Husky、设置 lint-staged,或为 JavaScript/TypeScript 仓库加入提交时的格式化、类型检查或测试时使用。
运行要求
需要一个带包管理器(npm、pnpm、yarn 或 bun)的 Node.js 仓库,并能联网安装 husky、lint-staged 和 prettier 作为开发依赖。该技能不包含脚本,仅为操作说明。

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 test scripts in the pre-commit hook

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

bash
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+):

npx lint-stagednpm run typechecknpm run test

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

5. Create .lintstagedrc

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

6. Create .prettierrc (if missing)

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

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

7. Verify

  • .husky/pre-commit exists and is executable
  • .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 test 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), then full typecheck and tests

来源与署名

来源:mattpocock/skills位于skills/misc/setup-pre-commit提交c55ee46

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架