Obsidian间隔重复插件中Git Hooks的工程化实践

在Obsidian-spaced-repetition插件项目中引入Git Hooks自动化工具链是一个典型的工程效率提升案例。本文将从技术实现角度解析如何通过Husky构建现代化的前端工程约束体系。

为什么需要Git Hooks

现代前端工程中，代码提交前的自动化检查已成为团队协作的基础设施。Obsidian作为基于Electron的Markdown工具，其插件开发同样需要保证：

1. 代码风格一致性（通过ESLint）
2. 提交信息规范化（约定式提交）
3. 自动化测试保障（Jest/Vitest）

技术方案设计

采用Husky + lint-staged组合方案可实现：

• 预提交钩子(pre-commit): 对暂存区的.ts/.vue文件自动执行eslint --fix
• 提交信息钩子(commit-msg): 强制采用Angular风格的提交信息格式
• 预推送钩子(pre-push): 运行完整的单元测试套件

具体实现要点

1. Husky初始化
   通过npx husky-init创建基础钩子目录结构，自动配置Git钩子路径

2. 多阶段钩子配置

# .husky/pre-commit
npx lint-staged --concurrent false

# .husky/commit-msg
npx commitlint --edit $1

3. lint-staged配置

// package.json
{
  "lint-staged": {
    "*.{ts,tsx}": ["eslint --fix", "prettier --write"]
  }
}

工程价值

1. 质量卡点：确保有语法错误的代码无法进入版本库
2. 规范治理：统一团队的提交信息风格
3. 效率提升：本地拦截问题比CI失败后修复成本更低

注意事项

1. 需要配合EditorConfig保证IDE基础配置一致
2. 建议在项目CONTRIBUTING.md中补充钩子使用说明
3. Windows环境需注意换行符问题（LF/CRLF）

该方案已在多个开源项目中验证，能显著提升Obsidian插件这类技术产品的协作开发体验。