用途:在当前仓库中设置提交前钩子,让每次 commit 前自动运行代码格式化、类型检查和测试,从而在提交阶段拦截问题。
主要能力:配置 Husky pre-commit 钩子;用 lint-staged 对所有暂存文件运行 Prettier;在缺少配置时创建 Prettier config;在 pre-commit 钩子中加入 typecheck 与 test 脚本。
使用方式:先检测包管理器,检查 package-lock.json(npm)、pnpm-lock.yaml(pnpm)、yarn.lock(yarn)、bun.lockb(bun),使用存在的那个,不清楚时默认 npm。然后以 devDependencies 安装 husky lint-staged prettier,运行 npx husky init 初始化 Husky,创建 .husky/ 目录并向 package.json 添加 prepare: "husky"。接着创建 .husky/pre-commit,内容为运行 lint-staged、typecheck、test(Husky v9+ 不需要 shebang;npm 替换为检测到的包管理器;若 package.json 没有对应脚本则省略该行并告知用户)。再创建 .lintstagedrc,内容为 {"*": "prettier --ignore-unknown --write"},并在缺失时创建 .prettierrc,使用给定默认配置。最后验证 .husky/pre-commit 存在且可执行、.lintstagedrc 存在、prepare script 为 "husky"、prettier config 存在,并运行 npx lint-staged 验证可用,再暂存所有更改并以消息 Add pre-commit hooks (husky + lint-staged + prettier) 提交,作为冒烟测试。
限制与备注:prettier --ignore-unknown 会跳过 Prettier 无法解析的文件(如图片);pre-commit 先运行只针对暂存文件的 lint-staged(较快),再运行完整 typecheck 和 tests。其他未在资料中说明的配置暂未提供。