mcpField
S
setup-pre-commit

setup-pre-commit

github.com/vinvcn测试与质量5.4k5.5k 次安装1 天前更新
代码仓库

关于 setup-pre-commit

setup-pre-commit 是为 JavaScript 项目配置提交前检查的技能，供维护项目工作流的开发者使用。它根据锁文件选择包管理器，设置 Husky、lint-staged 与 Prettier，并可在 hook 中运行 typecheck 和测试。

主要功能

  1. 01根据锁文件检测包管理器
  2. 02安装 Husky、lint-staged 和 Prettier
  3. 03配置 Husky pre-commit hook
  4. 04对暂存文件运行 Prettier
  5. 05运行可用的 typecheck 与测试脚本

适用场景

  1. 01为仓库添加提交前格式化
  2. 02在提交时运行类型检查
  3. 03在提交时运行测试
  4. 04验证并提交 hook 配置

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/vinvcn/mattpocock-skills-zh-cn --skill setup-pre-commit

安装后在 Claude Code 中输入/setup-pre-commit确认已加载。

附带文件agents/openai.yaml

README 原文English

来自项目 README

README 暂无中文译文，以下为英文原文；中文介绍见上方。

设置 Pre-Commit Hooks

这会配置什么

  • Husky pre-commit hook
  • lint-staged 对所有 staged files 运行 Prettier
  • Prettier config（如果缺失）
  • pre-commit hook 中的 typecheck 和 test scripts

步骤

1. 检测 package manager

检查 package-lock.json (npm)、pnpm-lock.yaml (pnpm)、yarn.lock (yarn)、bun.lockb (bun)。使用存在的那个。不清楚时默认 npm。

2. 安装依赖

作为 devDependencies 安装：

husky lint-staged prettier
3. 初始化 Husky
npx husky init

这会创建 .husky/ dir，并向 package.json 添加 prepare: "husky"。

4. 创建 .husky/pre-commit

写入这个文件（Husky v9+ 不需要 shebang）：

npx lint-staged
npm run typecheck
npm run test

Adapt：把 npm 替换为检测到的 package manager。如果 repo 的 package.json 没有 typecheck 或 test script，就省略对应行并告知用户。

5. 创建 .lintstagedrc
{
  "*": "prettier --ignore-unknown --write"
}
6. 创建 .prettierrc（如果缺失）

只有没有 Prettier config 时才创建。使用这些 defaults：

{
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": false,
  "trailingComma": "es5",
  "semi": true,
  "arrowParens": "always"
}
7. 验证
  • .husky/pre-commit 存在且可执行
  • .lintstagedrc 存在
  • package.json 中的 prepare script 是 "husky"
  • prettier config 存在
  • 运行 npx lint-staged 验证可用
8. 提交

Stage 所有 changed/created files，并用 message 提交：Add pre-commit hooks (husky + lint-staged + prettier)

这会经过新的 pre-commit hooks，是一个不错的 smoke test。

备注

  • Husky v9+ 不需要 hook files 中的 shebangs
  • prettier --ignore-unknown 会跳过 Prettier 无法 parse 的 files（images 等）
  • pre-commit 先运行 lint-staged（快，只针对 staged files），再运行完整 typecheck 和 tests

评论

支持 Markdown