@peiyanlu/release 0.0.3 → 0.0.5

package/dist/index.d.mts

@@ -1,30 +1,37 @@
 import { DeepPartial, DeepRequired } from "@peiyanlu/ts-utils";
+import { log } from "@clack/prompts";
 
-//#region src/git/changetype.d.ts
-interface CommitType {
-  type: string;
-  section: string;
-  description: string;
-}
-//#endregion
 //#region src/types.d.ts
 
+type Logger = typeof log;
 type HookTiming = 'before' | 'after';
 type HookAction = 'bump' | 'publish' | 'push' | 'release';
 type ReleaseHookKey = `${HookTiming}:${HookAction}`;
-type ReleaseHookValue = string | string[] | (() => Promise<void> | void);
+type ReleaseHookValue = string | string[] | ((logger: Logger) => Promise<void> | void);
 type HookConfig = { [key in ReleaseHookKey]: ReleaseHookValue };
 interface ReleaseConfig {
   /**
    * 生命周期钩子配置
+   * 用于在 Release 关键阶段注入自定义逻辑（如 before/after hooks）。
    */
   hooks: HookConfig;
+  /** 是否是 monorepo */
+  isMonorepo: boolean;
+  /** 使用 monorepo 时发布的包列表，后续回调的 `pkg`。默认为 `[]` 作为单仓库 */
+  packages: string[];
+  /** 使用 monorepo 时使用 getPkgDir，例如 `packages/${pkg}`。 默认为 `.` 作为单仓库 */
+  getPkgDir: (pkg: string) => string;
+  /** 使用 monorepo 时使用 toTag，例如 `${pkg}@${version}`，默认为 `v${version}` 作为单仓库 */
+  toTag: (pkg: string, version: string) => string;
+  /** 作为 CHANGELOG 标题的 Tag 前缀，多包场景下需要 `${pkg}@` */
+  tagPrefix: ((pkg: string) => string | undefined) | undefined;
   /**
    * Git 相关配置
+   * 影响提交、打 tag、推送等本地/远程 Git 行为。
    */
   git: {
     /**
-     * 是否创建提交
+     * 是否创建 Git 提交
      */
     commit: boolean | undefined;
     /**
@@ -40,7 +47,7 @@ interface ReleaseConfig {
      */
     commitMessage: string;
     /**
-     * 额外的 git commit 参数
+     * 额外的 git commit 参数（透传给 git CLI）
      */
     commitArgs: string[];
     /**
@@ -48,27 +55,23 @@ interface ReleaseConfig {
      */
     tagMessage: string;
     /**
-     * Git Tag 名称模板
-     */
-    tagName: string;
-    /**
-     * 额外的 git tag 参数
+     * 额外的 git tag 参数（透传给 git CLI）
      */
     tagArgs: string[];
     /**
-     * 额外的 git push 参数
+     * 额外的 git push 参数（透传给 git CLI）
      */
     pushArgs: string[];
     /**
-     * 是否自动添加未追踪的文件
+     * 是否自动添加未追踪的文件（git add -A）
      */
     addUntrackedFiles: boolean;
     /**
-     * 是否要求配置远程仓库
+     * 是否要求必须配置远程仓库（存在 git remote）
      */
     requireRemote: boolean;
     /**
-     * 是否要求当前目录为 Git 仓库
+     * 是否要求当前工作目录必须是 Git 仓库
      */
     requireRepository: boolean;
     /**
@@ -78,27 +81,29 @@ interface ReleaseConfig {
   };
   /**
    * NPM 发布相关配置
+   * 影响 npm publish 的目标路径、参数与前置校验。
    */
   npm: {
     /**
-     * 是否发布到 npm
+     * 是否启用 npm 发布流程
      */
     publish: boolean | undefined;
     /**
-     * 发布目录路径
+     * npm 发布目标路径，对应 `npm publish <package-spec>`
      */
     publishPath: string;
     /**
-     * 额外的 npm publish 参数
+     * 额外的 npm publish 参数（透传给 npm CLI）
      */
     pushArgs: string[];
     /**
-     * 是否跳过发布前检查
+     * 是否跳过发布前检查（如 ping、whoami 等校验）
      */
     skipChecks: boolean;
   };
   /**
    * GitHub Release 相关配置
+   * 控制是否创建 Release、发布方式以及上传资源。
    */
   github: {
     /**
@@ -106,27 +111,27 @@ interface ReleaseConfig {
      */
     release: boolean | undefined;
     /**
-     * Release 展示名称
+     * Release 展示名称（标题）
      */
     releaseName: string;
     /**
-     * 是否自动生成 Release Notes (CI)
+     * 是否由 GitHub 自动生成 Release Notes（通常用于 CI）
      */
     autoGenerate: boolean;
     /**
-     * 是否标记为预发布版本
+     * 是否标记为预发布版本（pre-release）
      */
     prerelease: boolean;
     /**
-     * 是否创建为草稿
+     * 是否创建为草稿（draft）
      */
     draft: boolean;
     /**
-     * GitHub Token 引用名称
+     * GitHub Token 引用名称（用于从环境变量或配置中读取）
      */
     tokenRef: string;
     /**
-     * 需要上传的 Release 资源文件
+     * 需要上传到 Release 的资源文件列表
      */
     assets: string[];
     /**
@@ -134,19 +139,6 @@ interface ReleaseConfig {
      */
     skipChecks: boolean;
   };
-  /**
-   * Changelog 生成相关配置
-   */
-  changelog: {
-    /**
-     * Changelog 输入文件路径
-     */
-    infile: string;
-    /**
-     * 用于生成 Changelog 的提交类型映射规则
-     */
-    types: CommitType[];
-  };
 }
 //#endregion
 //#region src/config.d.ts
@@ -163,4 +155,4 @@ declare function defineConfig(config: UserConfigFn): UserConfigFn;
 declare function defineConfig(config: UserConfigExport): UserConfigExport;
 declare const mergeConfig: <T extends object>(defaults: DeepRequired<T>, overrides?: DeepPartial<T>) => DeepRequired<T>;
 //#endregion
-export { type UserConfig, defineConfig, mergeConfig };
+export { type Logger, type UserConfig, defineConfig, mergeConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/release",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Release project tool.",
   "license": "MIT",
   "type": "module",
@@ -13,38 +13,41 @@
       "import": {
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
       }
-    }
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
     "dev": "tsdown -w",
     "build": "tsdown",
     "prepublish": "tsdown",
-    "test": "vitest run"
+    "release": "tsdown && node index.js",
+    "test": "vitest run",
+    "test:cov": "vitest run --coverage"
   },
   "dependencies": {
     "@clack/prompts": "^0.11.0",
     "@octokit/rest": "^22.0.1",
-    "@peiyanlu/cli-utils": "^0.0.4",
+    "@peiyanlu/cli-utils": "^0.0.6",
     "@peiyanlu/ts-utils": "^0.0.4",
     "ansis": "^4.2.0",
     "commander": "^14.0.2",
+    "conventional-changelog": "^7.1.1",
+    "conventional-changelog-conventionalcommits": "^9.1.0",
     "mime-types": "^3.0.2",
     "open": "^11.0.0",
+    "publint": "^0.3.17",
     "semver": "^7.7.3",
     "tinyglobby": "^0.2.15"
   },
   "devDependencies": {
-    "@types/semver": "^7.7.1",
     "@types/mime-types": "^3.0.1",
     "@types/node": "^24.10.3",
+    "@types/semver": "^7.7.1",
+    "@vitest/coverage-v8": "^4.0.15",
     "tsdown": "^0.18.4",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.15"
+    "vitest": "^4.0.18"
   },
   "author": {
     "name": "YanluPei",
@@ -66,7 +69,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/peiyanlu/release.git"
+    "url": "git+https://github.com/peiyanlu/release.git"
   },
   "bugs": {
     "url": "https://github.com/peiyanlu/release/issues"

package/dist/index.cjs

@@ -1,26 +0,0 @@
-let _peiyanlu_ts_utils = require("@peiyanlu/ts-utils");
-
-//#region src/config.ts
-function defineConfig(config) {
-	return config;
-}
-const isFunction = (v) => typeof v === "function";
-const mergeConfig = (defaults, overrides) => {
-	if (!overrides) return structuredClone(defaults);
-	if (Object.keys(defaults).length === 0) return structuredClone(overrides);
-	const result = {};
-	for (const key in defaults) {
-		const defaultValue = defaults[key];
-		const overrideValue = overrides[key];
-		if (overrideValue === void 0) if (isFunction(defaultValue)) result[key] = defaultValue;
-		else result[key] = structuredClone(defaultValue);
-		else if ((0, _peiyanlu_ts_utils.isPlainObject)(defaultValue) && (0, _peiyanlu_ts_utils.isPlainObject)(overrideValue)) result[key] = mergeConfig(defaultValue, overrideValue);
-		else if (isFunction(overrideValue)) result[key] = overrideValue;
-		else result[key] = structuredClone(overrideValue);
-	}
-	return result;
-};
-
-//#endregion
-exports.defineConfig = defineConfig;
-exports.mergeConfig = mergeConfig;

package/dist/index.d.cts

@@ -1,166 +0,0 @@
-import { DeepPartial, DeepRequired } from "@peiyanlu/ts-utils";
-
-//#region src/git/changetype.d.ts
-interface CommitType {
-  type: string;
-  section: string;
-  description: string;
-}
-//#endregion
-//#region src/types.d.ts
-
-type HookTiming = 'before' | 'after';
-type HookAction = 'bump' | 'publish' | 'push' | 'release';
-type ReleaseHookKey = `${HookTiming}:${HookAction}`;
-type ReleaseHookValue = string | string[] | (() => Promise<void> | void);
-type HookConfig = { [key in ReleaseHookKey]: ReleaseHookValue };
-interface ReleaseConfig {
-  /**
-   * 生命周期钩子配置
-   */
-  hooks: HookConfig;
-  /**
-   * Git 相关配置
-   */
-  git: {
-    /**
-     * 是否创建提交
-     */
-    commit: boolean | undefined;
-    /**
-     * 是否创建 Git Tag
-     */
-    tag: boolean | undefined;
-    /**
-     * 是否推送到远程仓库
-     */
-    push: boolean | undefined;
-    /**
-     * Git 提交信息模板
-     */
-    commitMessage: string;
-    /**
-     * 额外的 git commit 参数
-     */
-    commitArgs: string[];
-    /**
-     * Git Tag 的消息内容
-     */
-    tagMessage: string;
-    /**
-     * Git Tag 名称模板
-     */
-    tagName: string;
-    /**
-     * 额外的 git tag 参数
-     */
-    tagArgs: string[];
-    /**
-     * 额外的 git push 参数
-     */
-    pushArgs: string[];
-    /**
-     * 是否自动添加未追踪的文件
-     */
-    addUntrackedFiles: boolean;
-    /**
-     * 是否要求配置远程仓库
-     */
-    requireRemote: boolean;
-    /**
-     * 是否要求当前目录为 Git 仓库
-     */
-    requireRepository: boolean;
-    /**
-     * 是否要求工作目录保持干净（无未提交的更改）
-     */
-    requireWorkDirClean: boolean;
-  };
-  /**
-   * NPM 发布相关配置
-   */
-  npm: {
-    /**
-     * 是否发布到 npm
-     */
-    publish: boolean | undefined;
-    /**
-     * 发布目录路径
-     */
-    publishPath: string;
-    /**
-     * 额外的 npm publish 参数
-     */
-    pushArgs: string[];
-    /**
-     * 是否跳过发布前检查
-     */
-    skipChecks: boolean;
-  };
-  /**
-   * GitHub Release 相关配置
-   */
-  github: {
-    /**
-     * 是否创建 GitHub Release
-     */
-    release: boolean | undefined;
-    /**
-     * Release 展示名称
-     */
-    releaseName: string;
-    /**
-     * 是否自动生成 Release Notes (CI)
-     */
-    autoGenerate: boolean;
-    /**
-     * 是否标记为预发布版本
-     */
-    prerelease: boolean;
-    /**
-     * 是否创建为草稿
-     */
-    draft: boolean;
-    /**
-     * GitHub Token 引用名称
-     */
-    tokenRef: string;
-    /**
-     * 需要上传的 Release 资源文件
-     */
-    assets: string[];
-    /**
-     * 是否跳过 GitHub 发布前检查
-     */
-    skipChecks: boolean;
-  };
-  /**
-   * Changelog 生成相关配置
-   */
-  changelog: {
-    /**
-     * Changelog 输入文件路径
-     */
-    infile: string;
-    /**
-     * 用于生成 Changelog 的提交类型映射规则
-     */
-    types: CommitType[];
-  };
-}
-//#endregion
-//#region src/config.d.ts
-type UserConfig = DeepPartial<ReleaseConfig>;
-type UserConfigFnObject = () => UserConfig;
-type UserConfigFnPromise = () => Promise<UserConfig>;
-type UserConfigFn = () => UserConfig | Promise<UserConfig>;
-type UserConfigExport = UserConfig | Promise<UserConfig> | UserConfigFnObject | UserConfigFnPromise | UserConfigFn;
-declare function defineConfig(config: UserConfig): UserConfig;
-declare function defineConfig(config: Promise<UserConfig>): Promise<UserConfig>;
-declare function defineConfig(config: UserConfigFnObject): UserConfigFnObject;
-declare function defineConfig(config: UserConfigFnPromise): UserConfigFnPromise;
-declare function defineConfig(config: UserConfigFn): UserConfigFn;
-declare function defineConfig(config: UserConfigExport): UserConfigExport;
-declare const mergeConfig: <T extends object>(defaults: DeepRequired<T>, overrides?: DeepPartial<T>) => DeepRequired<T>;
-//#endregion
-export { type UserConfig, defineConfig, mergeConfig };