mcpField
G
git-hooks-setup

git-hooks-setup

github.com/aj-geddes测试与质量373447 次安装34 周前更新
代码仓库

关于 git-hooks-setup

用于配置 Git hooks 的技能，可在提交或推送前执行代码质量检查和自动防护。内容包括常见 hook 设置、信息验证、密钥检测和团队规范。

主要功能

  1. 01提交前 lint 与格式检查
  2. 02提交信息验证
  3. 03提交前检测密钥
  4. 04推送前运行测试
  5. 05Husky 与 pre-commit 配置指导

适用场景

  1. 01提交前统一代码格式
  2. 02拒绝格式错误的提交信息
  3. 03避免密钥进入提交
  4. 04推送更改前运行测试

安装

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

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill git-hooks-setup

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

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
commit-message-validation.md
commitlint-configuration.md
husky-installation-and-configuration.md
pre-commit-framework-python.md
pre-commit-hook-nodejs.md
secret-detection-hook.md
scripts/
scaffold-tests.sh
templates/
test-template.js

详细介绍

Git 钩子配置

目录

概述

配置 Git 钩子，以执行代码质量标准、运行自动化检查，并防止有问题的提交被推送到共享仓库。

适用场景

  • 提交前代码质量检查
  • 提交消息验证
  • 防止在提交中包含机密信息
  • 推送前运行测试
  • 强制执行代码格式规范
  • 配置代码检查
  • 强制执行团队统一标准

快速开始

最小可用示例：

#!/bin/bash
# setup-husky.sh

# Install Husky
npm install husky --save-dev

# Initialize Husky
npx husky install

# Create pre-commit hook
npx husky add .husky/pre-commit "npm run lint"

# Create commit-msg hook
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

# Create pre-push hook
npx husky add .husky/pre-push "npm run test"

# Create post-merge hook
npx husky add .husky/post-merge "npm install"

参考指南

references/ 目录中的详细实现：

指南内容
Husky 安装与配置Husky 安装与配置
提交前钩子（Node.js）提交前钩子（Node.js）
提交消息验证提交消息验证
Commitlint 配置Commitlint 配置、推送前钩子（综合）
提交前框架（Python）提交前框架（Python）
机密信息检测钩子机密信息检测钩子、package.json 中的 Husky

最佳实践

✅ 应该做
  • 强制执行提交前代码检查和格式化
  • 验证提交消息格式
  • 提交前扫描机密信息
  • 推送前运行测试
  • 仅在少数情况下使用 --no-verify 跳过钩子
  • 在 README 中记录钩子要求
  • 使用一致的钩子配置
  • 确保钩子运行快速（< 5 秒）
  • 提供有帮助的错误消息
  • 在提供明确警告的情况下允许开发者绕过检查
❌ 不应该做
  • 使用 --no-verify 跳过检查
  • 在已提交的文件中存储机密信息
  • 使用不一致的实现
  • 忽略钩子错误
  • 在提交前运行完整测试套件

评论

支持 Markdown