@vitarx/init-husky
v1.1.0
Published
初始化husky,可用于任意项目。
Downloads
48
Readme
@vitarx/init-husky
一键初始化 Husky + Commitlint 的 npm 工具,适合 TypeScript 项目,自动生成
commit-msg钩子和commitlint.config.ts配置文件。
特性
- 自动安装依赖:
husky、@commitlint/cli、@commitlint/config-conventional、tsx - 初始化
.husky目录 - 添加
commit-msg钩子,自动执行 commitlint - 生成
commitlint.config.ts,默认支持 Conventional Commits
安装
全局安装(可选):
pnpm add -D @vitarx/init-husky使用 npx 或 pnpm dlx 直接执行:
npx @vitarx/init-husky
# 或
pnpm dlx @vitarx/init-husky使用方法
在项目根目录运行:
npx @vitarx/init-husky
# 或
init-husky # 必须全局安装!执行后会自动完成:
- 安装必要依赖
- 初始化 .husky 目录
- 创建 commit-msg 钩子
- 添加或更新 package.json 的 prepare 脚本
- 生成 commitlint.config.ts
如果已经存在 .husky 或 commitlint.config.ts,会跳过创建,防止覆盖。
