@perryfinn/ai-commit-cli

ai-commit-cli

本项目受 opencommit 的启发

特性

• TypeScript 严格模式与现代 TS 配置（strict、noUncheckedIndexedAccess 等）
• 使用 tsdown 打包产出 CJS/ESM，同时生成类型声明（.d.ts）与 Source Map
• 完整的 ESM/CJS 导出映射（package.json#exports、main、module、types）
• Biome 提供 Lint/格式化与简易 CI 集成
• Vitest 测试，V8 覆盖率，内置最低 90% 的覆盖率门槛（bunfig.toml）
• Changesets 版本与发布流程，并支持自定义提交消息（scripts/changeset.commit.ts）
• Husky + lint-staged + Commitlint 提交质量门禁（约定式提交）
• 推荐使用 Bun 安装依赖并运行脚本，享受更快的安装与执行速度
• 使用 Volta 固定 Node 版本，确保一致的本地/CI 环境
• attw（AreTheTypesWrong）导出与类型正确性校验

贡献指南

请参阅 Repository Guidelines 了解项目结构、开发流程与提交规范。

环境要求

• Node >= 22（Volta 固定为 22.19.0）
• Bun >= 1.0.0
• 包管理器：推荐使用 Bun；如需使用 npm/pnpm，请确保锁文件与依赖树保持一致

安装

bun install

注：仓库在 bunfig.toml 中启用了 linker = "isolated"，安装结果类似 pnpm 的非平铺结构；若需切换策略，请先删除现有 node_modules/。

快速开始（CLI 示例）

构建 CLI：

bun run build

配置（AIGCM_ 前缀，默认 Provider=OPEN_AI，Language=zh_CN）：

node ./dist/index.cjs config set AIGCM_MODEL_ID=gpt-4o AIGCM_ONE_LINE_COMMIT=true AIGCM_MAX_TOKEN_INPUT=1024
node ./dist/index.cjs config get AIGCM_MODEL_ID
node ./dist/index.cjs config ls

Debug 示例（脚本同 package.json#scripts.debug）：

bun run debug

配置项取值优先级

从高到低（上层存在即覆盖下层）：

• 命令行环境变量（进程环境中的 AIGCM_*）
• 仓库根目录的 .env 文件中的 AIGCM_*
• 配置文件（conf 持久化存储）

补充说明：

• config set 仅写入配置文件层，不会修改环境变量或 .env。
• config get/config ls 会在值后显示来源标识：[cli]、[.env] 或 [config]。

作为库使用

当你将本模板产物发布到 npm 后，可按如下方式在其他项目中使用。

ESM：

import { add, type DemoType } from 'create-npm-package';

const result = add(2, 3);
console.log(result); // 5

const user: DemoType = { name: 'Tom' };

CJS：

const { add } = require('create-npm-package');

console.log(add(2, 3)); // 5

常用脚本

• 开发与质量
  • bun run lint：Biome 检查
  • bun run lint:fix：Biome 自动修复
  • bun run typecheck：TypeScript 类型检查
  • bun run test：Vitest 全量测试
  • bun run test:watch：Vitest 监听模式
  • bun run test:coverage：生成覆盖率报告
• 构建与校验
  • bun run build：使用 tsdown 打包（CJS/ESM + d.ts + sourcemap → dist/）
  • bun run check:exports：使用 attw 校验导出与类型
• 发布（Changesets）
  • bun run release:version：根据变更集生成版本号与 CHANGELOG
  • bun run release：发布到当前 registry（需已登录）
• 其他
  • bun run ci：本地串跑 CI（lint → typecheck → test → build → check:exports）
  • bun run build:changeset：编译 scripts/changeset.commit.ts 为 .changeset/changeset.commit.cjs

说明：prepublishOnly 会在发布前自动执行 bun run ci，确保发布质量。

目录结构

.
├─ src/
│  ├─ index.ts                 # CLI 入口
│  ├─ cli/                     # 子命令与解析器
│  ├─ config/                  # 配置管理
│  ├─ types/                   # 类型与 JSON Schema
│  ├─ utils/                   # 工具函数（含 env 解析）
│  └─ utils.ts                 # 通用工具
├─ tests/
│  └─ utils.test.ts     # Vitest 示例用例
├─ scripts/
│  └─ changeset.commit.ts   # Changesets 自定义提交消息生成逻辑
├─ dist/                 # 构建产物（build 后生成）
├─ tsdown.config.ts      # 打包配置（含 changeset 构建目标）
├─ vitest.config.ts      # 测试配置（V8 覆盖率）
├─ bunfig.toml           # Bun 配置（覆盖率阈值、registry）
├─ tsconfig.json         # TypeScript 配置（严格模式等）
├─ package.json          # 脚本、导出映射、引擎/工具声明等
└─ CHANGELOG.md          # 版本变更记录（由 Changesets 生成）

构建与产物说明

• 入口：src/index.ts
• 产物目录：dist/
• 产物类型：
  • index.js（ESM）
  • index.cjs（CJS）
  • index.d.ts / index.d.cts（类型声明）
  • *.map（Source Map）
• 导出映射：见 package.json#exports，同时提供 main/module/types 字段方便生态工具识别。

测试

使用 Vitest，覆盖率提供方为 V8：

bun run test
bun run test:coverage

版本与发布（Changesets）

• 添加变更集（选择变更类型并填写说明）：

  bunx changeset
  

• 生成版本号与变更日志：

  bun run release:version
  

• 发布到 npm（或当前 registry）：

  bun run release
  

可选：若需自定义 Changesets 的提交消息格式，执行：

bun run build:changeset

该命令会将 scripts/changeset.commit.ts 编译为 .changeset/changeset.commit.cjs，供 Changesets 读取使用。

FAQ

• 为什么推荐使用 Bun？
  • Bun 在安装和执行脚本时更快，且本仓库默认使用 Bun 生成锁文件；若使用其他包管理器，请确保不会覆写 bun.lock。
• Node 版本不满足怎么办？
  • 请将 Node 升级到 >=22，或使用 Volta/nvm 切换到合适版本。仓库使用 Volta 固定为 22.19.0。
• attw 检查失败？
  • 说明导出或类型存在潜在问题，请根据错误信息调整导出或类型定义，然后重新 bun run build && bun run check:exports。

许可证

MIT © PerryFinn