Git Hooks Setup

Git Hooks Setup

一键配置 Git Hooks，标准化团队开发流程。

Overview

自动生成 pre-commit / commit-msg / pre-push hook 配置，包含代码格式化、commit message 校验、敏感信息检查。支持 husky 和原生 git hooks 两种方案。

When to Use

• User wants to set up git hooks
• User mentions pre-commit or commit message conventions
• User wants to automate lint/format checks
• User inputs /git-hooks-setup
• User wants to enforce pre-push checks (tests, lint)
• User wants to prevent pushing broken code
• User wants to standardize team commit message format
• User wants to add secret scanning before commit
• User wants to auto-format code on every commit

When NOT to Use:

• User only wants to view current git hooks configuration
• User wants CI-based checks (no local hooks needed)
• User's project already has a complete hooks setup
• User wants to run hooks on specific files only (use lint-staged directly)
• User wants to hook into Git events other than pre-commit/commit-msg/push

Core Pattern

Step 1: 检测项目环境

# 检测包管理器
if [ -f "package-lock.json" ]; then
  echo "npm"
  PACKAGE_MANAGER="npm"
elif [ -f "yarn.lock" ]; then
  echo "yarn"
  PACKAGE_MANAGER="yarn"
elif [ -f "pnpm-lock.yaml" ]; then
  echo "pnpm"
  PACKAGE_MANAGER="pnpm"
else
  echo "未检测到包管理器"
  PACKAGE_MANAGER="unknown"
fi

# 检测是否已有 hooks
if [ -d ".husky" ]; then
  echo "husky 已配置"
elif [ -f ".git/hooks/pre-commit" ] && ! grep -q "husky" .git/hooks/pre-commit 2>/dev/null; then
  echo "原生 hooks 已配置"
fi

# 检测 lint 工具
if [ -f "package.json" ]; then
  echo "已安装的 lint 工具:"
  cat package.json | python3 -c "
import sys,json
d=json.load(sys.stdin)
dev_deps=d.get('devDependencies',{})
lint_tools=[k for k in dev_deps if 'eslint' in k or 'prettier' in k or 'lint' in k]
if lint_tools:
    for tool in lint_tools:
        print(f'  - {tool}')
else:
    print('  未检测到 lint 工具')
"
fi

Step 2: 选择方案

Step 3: 生成配置

方案 A: Husky

# 安装 husky 并初始化
if [ "$PACKAGE_MANAGER" = "pnpm" ]; then
  pnpm add -D husky && pnpm exec husky init
elif [ "$PACKAGE_MANAGER" = "yarn" ]; then
  yarn add -D husky && yarn husky init
else
  npm install -D husky && npx husky init
fi

生成 .husky/pre-commit：

# 根据包管理器选择命令
if [ "$PACKAGE_MANAGER" = "pnpm" ]; then
  pnpm dlx lint-staged
elif [ "$PACKAGE_MANAGER" = "yarn" ]; then
  yarn dlx lint-staged
else
  npx lint-staged
fi

生成 .husky/commit-msg：

# 根据包管理器选择命令（--no 仅 npx 有效，防止 npx 联网安装）
if [ "$PACKAGE_MANAGER" = "pnpm" ]; then
  pnpm exec commitlint --edit ${1}
elif [ "$PACKAGE_MANAGER" = "yarn" ]; then
  yarn commitlint --edit ${1}
else
  npx --no -- commitlint --edit ${1}
fi

生成 lint-staged 配置（在 package.json 中）：

{
  "lint-staged": {
    "*.{ts,tsx,js,jsx}": ["eslint --fix", "prettier --write"],
    "*.{json,md,yml}": ["prettier --write"]
  }
}

生成 .husky/pre-push（可选，push 前跑测试）：

# 根据包管理器选择命令
if [ "$PACKAGE_MANAGER" = "pnpm" ]; then
  pnpm test
elif [ "$PACKAGE_MANAGER" = "yarn" ]; then
  yarn test
else
  npm test
fi

方案 B: 原生 git hooks

cat > .git/hooks/pre-commit << 'EOF'
#!/bin/sh
# 自动 lint + format（按项目实际替换命令；示例为 Node 项目）
if [ -f "package.json" ] && [ -x "$(command -v npm)" ]; then
  npm run lint -- --fix 2>/dev/null || true
  npm run format 2>/dev/null || true
fi
git add -u
EOF
chmod +x .git/hooks/pre-commit

# pre-push hook（可选，push 前跑测试；按项目实际替换）
cat > .git/hooks/pre-push << 'EOF'
#!/bin/sh
if [ -f "package.json" ] && [ -x "$(command -v npm)" ]; then
  npm test || exit 1
fi
EOF
chmod +x .git/hooks/pre-push

Step 4: 配置 Commit Message 规范

将 templates/commitlint.config.js 复制到项目根目录（commitlint.config.js）。该配置基于 @commitlint/config-conventional，校验 commit message 格式：

type(scope): subject

# type: feat|fix|docs|style|refactor|test|chore|perf|ci|build|revert
# scope: 可选，影响范围
# subject: 简短描述（header-max-length 限制 100 字符）

同步安装 commitlint 依赖：

npm install -D @commitlint/cli @commitlint/config-conventional

Step 5: 添加敏感信息检查

生成 pre-commit hook 中加入：

# 检查是否有密钥泄露（仅扫描新增/修改的文本文件，跳过二进制和删除文件）
if git diff --cached --diff-filter=ACM --name-only -z | xargs -0 grep -IlE "password|secret|token|api_key" 2>/dev/null | grep -q .; then
  echo "警告: 检测到可能的敏感信息，请检查后重新提交"
  exit 1
fi

Quick Reference

/git-hooks-setup                    # 交互式选择方案和 hooks
/git-hooks-setup --husky            # 直接用 husky
/git-hooks-setup --native           # 直接用原生 git hooks

Common Mistakes

Git Hooks Setup

One-click configuration of Git Hooks to standardize team development workflow.

Installation

# npx skills (recommended)
npx skills add wu529778790/shenzjd-skills -s git-hooks-setup -y

# Manual (Claude Code)
git clone https://github.com/wu529778790/shenzjd-skills.git
cp -r shenzjd-skills/git-hooks-setup ~/.claude/skills/

# Manual (Cursor)
# Copy SKILL.md content to .cursorrules or .cursor/rules/

Usage

/git-hooks-setup                    # Interactive setup
/git-hooks-setup --husky            # Use husky
/git-hooks-setup --native           # Use native git hooks

Configured Hooks

Supported Solutions