@peiyanlu/release 1.2.1 → 1.3.1

package/dist/cli.mjs

@@ -1,12 +1,12 @@
 import { bold, compareUrl, each, heading, link, list, newline, segments, small, words } from "@conventional-changelog/template";
 import { bumpPackageVersion, coloredStatus, eol, execAsync, getAuthenticatedUser, getGithubReleaseUrl, getGithubUrl, getLatestTag, getLogSince, getPackageInfo, getPackageUrl, getPublishedVersion, getRemoteList, getRemoteNames, getShortStatus, gitAddAll, gitAddSync, gitAddTracked, gitBranchCurrent, gitCommitMessage, gitPushBranch, gitPushTag, gitResetHardSync, gitTagAnnotated, gitTagDeleteSync, hasWriteAccess, isGitRepo, isOtpError, isPrerelease, isValidVersion, isWorkingTreeClean, parseGitHubRepo, parseVersion, pingRegistry, publishPackage, registryArg, resolveChangelogRange, resolvePublishTag, runNpm } from "@peiyanlu/cli-utils";
-import { copyDir, createMatcher, createTempDir, editFile, readJsonFile, readJsonFileSync, writeJsonFile } from "@peiyanlu/node-utils";
+import { copyDir, createMatcher, createTempDir, editFile, normalizePath, readJsonFile, readJsonFileSync, writeJsonFile } from "@peiyanlu/node-utils";
+import { castArray, dedent, isBoolean, isEmpty, isEmptyObject, isFunction, isNotEmpty, isNumber, isPlainObject, isUndefined, isZero, nonNullable, omit, partition, sleep, unset } from "@peiyanlu/ts-utils";
 import { dim, green, red, rgb, underline, yellow } from "ansis";
 import { program } from "commander";
 import { createReadStream, createWriteStream, existsSync, readFileSync, statSync, writeFileSync } from "node:fs";
-import { join, resolve } from "node:path";
+import { basename, dirname, join, resolve } from "node:path";
 import { cancel, confirm, group, intro, isCancel, log, outro, select, tasks, text } from "@clack/prompts";
-import { castArray, isBoolean, isEmptyObject, isFunction, isNotEmpty, isNumber, isPlainObject, isUndefined, isZero, omit, partition, unset } from "@peiyanlu/ts-utils";
 import { publint } from "publint";
 import { formatMessage } from "publint/utils";
 import { inc, neq } from "semver";
@@ -20,10 +20,11 @@ import { finished } from "node:stream/promises";
 import { Octokit } from "@octokit/rest";
 import { contentType } from "mime-types";
 import open from "open";
-import { glob } from "tinyglobby";
+import { glob, globSync } from "tinyglobby";
+import { parse } from "yaml";
 //#region package.json
 var name = "@peiyanlu/release";
-var version = "1.2.0";
+var version = "1.3.0";
 var description = "Release project tool.";
 //#endregion
 //#region src/config.ts
@@ -92,11 +93,11 @@ const MSG = {
 		},
 		NPM: {
 			CHECKING: "Checking npm registry",
-			CHECKED: (registry, msg) => `NPM registry: ${underline(dim(registry))} ${underline(dim(msg))}`
+			CHECKED: (registry, msg) => `NPM registry: ${underline(dim(registry))} ${dim(msg)}`
 		},
 		GITHUB: {
 			CHECKING: "Checking github repository",
-			CHECKED: (repository, msg) => `GitHub repository: ${underline(dim(repository))} ${underline(dim(msg))}`
+			CHECKED: (repository) => `GitHub repository: ${underline(dim(repository))}`
 		}
 	},
 	TASK: {
@@ -158,44 +159,25 @@ const MSG = {
 //#region src/git/commit.ts
 const gitCheck = async (ctx, config) => {
 	const { pkg: { name } } = ctx;
-	const { git: { requireRepository, requireRemote, requireCleanWorkingTree }, skipGit, skipGithub } = config;
-	if (skipGit) {
-		ctx.noGit = true;
-		ctx.noGitHub = true;
-		return;
-	}
+	const { git: { requireRepository, requireRemote, requireCleanWorkingTree } } = config;
 	if (!await isGitRepo()) if (requireRepository) throw new Error(MSG.ERROR.GIT_REGISTRY(name));
 	else {
 		ctx.noGit = true;
-		ctx.noGitHub = true;
 		return;
 	}
 	if (requireCleanWorkingTree && !await isWorkingTreeClean()) throw new Error(MSG.ERROR.GIT_WORKDIR);
-	if (skipGithub) {
-		ctx.noGitHub = true;
-		return;
-	}
 	const remote = (await getRemoteList())[0];
 	const { name: remoteName = "origin", url: remoteUrl } = remote ?? {};
-	if (!remote || !remoteUrl) if (requireRemote) throw new Error(MSG.ERROR.GIT_REMOTE(remoteName));
-	else {
-		ctx.noGitHub = true;
-		return;
+	if (!remote || !remoteUrl) {
+		if (requireRemote) throw new Error(MSG.ERROR.GIT_REMOTE(remoteName));
 	}
 	Object.assign(ctx.git, {
 		remoteName,
 		remoteUrl
 	});
-	const [owner, repo] = parseGitHubRepo(remoteUrl);
-	const url = getGithubUrl(owner, repo);
-	Object.assign(ctx.github, {
-		owner,
-		repo,
-		url
-	});
 };
 const commitAndTag = async (ctx, config) => {
-	const { git: { remoteName, currentTag, commitMessage, tagMessage }, dryRun } = ctx;
+	const { git: { currentTag, commitMessage, tagMessage }, dryRun } = ctx;
 	const { git: { commit, tag, push, addUntrackedFiles, commitArgs, tagArgs, pushArgs } } = config;
 	if (!commit) return;
 	const args = dryRun ? ["--dry-run"] : [];
@@ -384,7 +366,8 @@ const createDefaultContext = () => {
 				registry: "https://registry.npmjs.org"
 			},
 			preId: "beta",
-			preBase: "0"
+			preBase: "0",
+			scope: void 0
 		},
 		npm: {
 			username: "",
@@ -483,7 +466,8 @@ const createDefaultConfig = (isCI) => {
 			draft: false,
 			tokenRef: "GITHUB_TOKEN",
 			assets: [],
-			skipChecks: false
+			skipChecks: false,
+			shortNotes: false
 		}
 	};
 };
@@ -613,6 +597,10 @@ function headerPartial(context) {
 	const fullTitle = words(linkCompare && !isLikelyHash(previousTag) ? link(version, compareUrl(context)) : version, title && `"${title}"`, date && `(${date})`);
 	return heading(2, isPatch ? small(fullTitle) : fullTitle);
 }
+function preamblePartial(contest) {
+	const { preamble, commitGroups, noteGroups } = contest;
+	return segments(preamble, isEmpty(preamble) && isEmpty(commitGroups) && isEmpty(noteGroups) && "Version bump without any changes.");
+}
 function template(context) {
 	const { headerPartial, preamblePartial, commitPartial, footerPartial, noteGroups, commitGroups } = context;
 	return segments(headerPartial(context), preamblePartial(context), each(noteGroups, (group) => segments(heading(3, words("⚠", group.title)), list(group.notes, (note) => {
@@ -622,14 +610,18 @@ function template(context) {
 //#endregion
 //#region src/git/changelog.ts
 const parsePreset = (options = {}) => {
-	const { includeHidden, transformTypes } = options;
+	const { includeHidden, transformTypes, scope } = options;
 	let types = [...defaultTypes];
 	if (includeHidden) types.forEach((type) => {
 		if (type.effect === "hidden") type.effect = "changelog";
 	});
 	types = transformTypes?.(types) ?? types;
-	const preset = createPreset({ types });
+	const preset = createPreset({
+		types,
+		scope
+	});
 	preset.writer ??= {};
+	preset.writer.preamblePartial = preamblePartial;
 	preset.writer.headerPartial = headerPartial;
 	preset.writer.template = template;
 	return preset;
@@ -645,11 +637,12 @@ const inferReleaseType = async (options) => {
 	} : releaseType;
 };
 const createGenerator = async (options) => {
-	const { getPkgDir, tagPrefix, releaseCount = 1, includeHidden, transformTypes } = options;
+	const { getPkgDir, tagPrefix, releaseCount = 1, includeHidden, transformTypes, scope } = options;
 	const pkgDir = getPkgDir();
 	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(parsePreset({
 		includeHidden,
-		transformTypes
+		transformTypes,
+		scope
 	})).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
 };
 const getChangelog = async (options) => {
@@ -677,10 +670,10 @@ const generateChangelog = async (options) => {
 //#endregion
 //#region src/git/prompts.ts
 const runGitPrompts = async (ctx, config) => {
-	const { git: { currentTag, commitMessage }, configFileExists: cfe, dryRun } = ctx;
+	const { git: { currentTag, commitMessage }, configFileExists: cfe, dryRun, isCI } = ctx;
 	const { git: { commit, tag, push } } = config;
 	const logs = [];
-	const shouldPrompt = (val) => isUndefined(val) || dryRun;
+	const shouldPrompt = (val) => isUndefined(val) || dryRun && !isCI;
 	const { log: _, ...reset } = await group({
 		commit: () => {
 			return shouldPrompt(commit) ? confirm({ message: question(MSG.PROMPT.GIT_COMMIT(commitMessage), "git") }) : (() => {
@@ -716,10 +709,10 @@ const runGitPrompts = async (ctx, config) => {
 //#endregion
 //#region src/github/prompts.ts
 const runGithubPrompts = async (ctx, config) => {
-	const { configFileExists: cfe, dryRun, github: { releaseName } } = ctx;
+	const { configFileExists: cfe, dryRun, github: { releaseName }, isCI } = ctx;
 	const { github: { release } } = config;
 	const logs = [];
-	const shouldPrompt = (val) => isUndefined(val) || dryRun;
+	const shouldPrompt = (val) => isUndefined(val) || dryRun && !isCI;
 	const res = await group({
 		release: () => shouldPrompt(release) ? confirm({ message: question(MSG.PROMPT.GITHUB_RELEASE(releaseName), "github") }) : (() => {
 			logs.push(yellow`github.release`);
@@ -824,24 +817,34 @@ const createWebRelease = async (options) => {
 	}).forEach(([key, value]) => {
 		url.searchParams.set(key, value);
 	});
-	const isWindows = process.platform === "win32";
-	await open(url.toString(), { wait: isWindows });
+	await open(url.toString());
+	await sleep(1e3 * 1.5);
 };
+const isGitHubActions = Boolean(process.env.GITHUB_ACTIONS);
 const githubCheck = async (ctx, config) => {
-	const { github: { owner, repo }, isCI } = ctx;
+	const { git: { remoteUrl } } = ctx;
 	const { github: { tokenRef, skipChecks } } = config;
+	if (!remoteUrl || isEmpty(parseGitHubRepo(remoteUrl))) {
+		ctx.noGitHub = true;
+		return;
+	}
+	const [owner, repo] = parseGitHubRepo(remoteUrl);
+	const url = getGithubUrl(owner, repo);
+	Object.assign(ctx.github, {
+		owner,
+		repo,
+		url
+	});
 	const token = tokenRef ? process.env[tokenRef] : process.env.GITHUB_TOKEN;
 	if (!token) {
 		Object.assign(ctx.github, { isWeb: true });
-		if (isCI && process.env.GITHUB_ACTIONS) throw new Error(MSG.ERROR.GITHUB_TOKEN(tokenRef));
-		return "";
+		if (isGitHubActions) throw new Error(MSG.ERROR.GITHUB_TOKEN(tokenRef));
+		return;
 	}
 	Object.assign(ctx.github, { token });
-	if (skipChecks) return "";
-	let username = "";
-	if (process.env.GITHUB_ACTIONS) username = process.env.GITHUB_ACTOR;
-	else {
+	if (!isGitHubActions && !skipChecks) {
 		const octokit = new Octokit({ auth: token });
+		let username = "";
 		try {
 			const { data: { login } } = await octokit.users.getAuthenticated();
 			username = login;
@@ -858,7 +861,6 @@ const githubCheck = async (ctx, config) => {
 			throw new Error(MSG.ERROR.GITHUB_USER);
 		}
 	}
-	return username;
 };
 const createRelease = async (ctx, config) => {
 	const { pkg: { name, toPreRelease }, git: { currentTag }, isCI, dryRun } = ctx;
@@ -903,11 +905,11 @@ const createRelease = async (ctx, config) => {
 //#endregion
 //#region src/npm/prompts.ts
 const runNpmPublishPrompts = async (ctx, config) => {
-	const { pkg: { name, next }, configFileExists: cfe, dryRun } = ctx;
+	const { pkg: { name, next }, configFileExists: cfe, dryRun, isCI } = ctx;
 	const { npm: { publish } } = config;
 	const logs = [];
 	const target = `${name}@${next}`;
-	const shouldPrompt = (val) => isUndefined(val) || dryRun;
+	const shouldPrompt = (val) => isUndefined(val) || dryRun && !isCI;
 	const res = await group({
 		publish: () => shouldPrompt(publish) ? confirm({ message: question(MSG.PROMPT.NPM_PUBLISH(target), "npm") }) : (() => {
 			logs.push(yellow`npm.publish`);
@@ -1132,7 +1134,7 @@ var Action = class {
 		console.log();
 		const { otp, package: defPkg, prepare, showChangelog, showRelease, ci, dryRun, onlyChangelog } = options;
 		intro(prepare ? MSG.INTRO_PREPARE(dryRun) : MSG.INTRO(dryRun));
-		const { isMonorepo, packages, getPkgDir, skipNpm } = config;
+		const { isMonorepo, packages, getPkgDir, skipGit, skipNpm, skipGithub } = config;
 		if (isMonorepo) {
 			if (ci) {
 				if (!defPkg) abortTask(MSG.ABORT.MONOREPO_CI_NO_PACKAGE);
@@ -1177,9 +1179,12 @@ var Action = class {
 				current: pkgVersion,
 				next: nextVersion,
 				toPreRelease: false,
-				publishConfig: { ...publishConfig }
+				publishConfig: { ...publishConfig },
+				scope: isEmpty(selectedPkg) ? void 0 : selectedPkg
 			},
-			noNpm: pkgPrivate || skipNpm
+			noGit: skipGit,
+			noNpm: pkgPrivate || skipNpm,
+			noGitHub: skipGit || skipGithub
 		});
 		const { messages } = await publint({ pkgDir });
 		for (const message of messages) {
@@ -1220,8 +1225,9 @@ var Action = class {
 		return resolveConfig(cwd);
 	}
 	async printChangelog(ctx, config) {
-		const { showChangelog, selectedPkg, noGit, isIncrement } = ctx;
+		const { showChangelog, selectedPkg, noGit, isIncrement, pkg: { scope } } = ctx;
 		const { isMonorepo, getPkgDir, changelog: { tagPrefix, releaseCount, includeHidden, transformTypes } } = config;
+		const { github: { shortNotes } } = config;
 		if (noGit) return;
 		const match = isMonorepo ? `${tagPrefix?.(selectedPkg)}*` : "*";
 		const { from, to } = isZero(releaseCount) ? {
@@ -1232,11 +1238,13 @@ var Action = class {
 		const changelog = await getChangelog({
 			getPkgDir: () => getPkgDir(selectedPkg),
 			tagPrefix: tagPrefix?.(selectedPkg),
+			scope: isEmpty(nonNullable([scope])) ? void 0 : nonNullable([scope]),
 			releaseCount,
 			includeHidden,
 			transformTypes
 		});
-		Object.assign(ctx.github, { changelog });
+		const short = `Please refer to [CHANGELOG.md](${getPkgDir(selectedPkg)}/CHANGELOG.md) for details.`;
+		Object.assign(ctx.github, { changelog: shortNotes ? short : changelog });
 		if (commits) {
 			msg("GIT", `Changelog(${from}...${to}):${eol(2)}` + changelog);
 			msg("GIT", `Commits(${from}...${to}):${eol(2)}` + commits);
@@ -1252,7 +1260,8 @@ var Action = class {
 					await gitCheck(ctx, config);
 					const { git: { remoteName, remoteUrl } } = ctx;
 					return success(MSG.CHECK.GIT.CHECKED(remoteName, remoteUrl), dryRun);
-				}
+				},
+				enabled: !ctx.noGit
 			},
 			{
 				title: MSG.CHECK.NPM.CHECKING,
@@ -1266,10 +1275,10 @@ var Action = class {
 			{
 				title: MSG.CHECK.GITHUB.CHECKING,
 				task: async () => {
-					const msg = await githubCheck(ctx, config);
+					await githubCheck(ctx, config);
 					const { github: { owner, repo } } = ctx;
 					const repository = getGithubUrl(owner, repo);
-					return success(MSG.CHECK.GITHUB.CHECKED(repository, msg), dryRun);
+					return success(MSG.CHECK.GITHUB.CHECKED(repository), dryRun);
 				},
 				enabled: !(ctx.noGitHub || onlyChangelog)
 			}
@@ -1291,7 +1300,7 @@ var Action = class {
 			});
 			if (res) msg("BUMP", res.reason);
 			const inferred = res?.releaseType;
-			const nextVersion = (isCI ? inferred ?? inc(current, "patch") : void 0) || await runVersionPrompts(ctx, config, inferred);
+			const nextVersion = (isCI ? inc(current, inferred ?? "patch") : void 0) || await runVersionPrompts(ctx, config, inferred);
 			ctx.isIncrement = neq(current, nextVersion);
 			const { version: next, isPrerelease: toPreRelease, preId, preBase } = parseVersion(nextVersion);
 			Object.assign(ctx.pkg, {
@@ -1318,7 +1327,7 @@ var Action = class {
 		await this.printChangelog(ctx, config);
 	}
 	async changelogTask(ctx, config) {
-		const { isIncrement, dryRun, selectedPkg, noGit, onlyChangelog } = ctx;
+		const { isIncrement, dryRun, selectedPkg, noGit, onlyChangelog, pkg: { scope } } = ctx;
 		const { getPkgDir, changelog: { tagPrefix, releaseCount, includeHidden, transformTypes } } = config;
 		if (noGit) return;
 		await tasks([{
@@ -1327,6 +1336,7 @@ var Action = class {
 				await generateChangelog({
 					getPkgDir: () => getPkgDir(selectedPkg),
 					tagPrefix: tagPrefix?.(selectedPkg),
+					scope: isEmpty(nonNullable([scope])) ? void 0 : nonNullable([scope]),
 					releaseCount,
 					includeHidden,
 					transformTypes
@@ -1399,6 +1409,45 @@ var Action = class {
 	}
 };
 //#endregion
+//#region src/monorepo/packages.ts
+const scanWorkspacePackages = (cwd) => {
+	const workspaceFile = join(cwd, "pnpm-workspace.yaml");
+	if (!existsSync(workspaceFile)) return [];
+	const { packages = [] } = parse(readFileSync(workspaceFile, "utf8"));
+	return globSync(packages.map((pattern) => normalizePath(join(pattern, "package.json"))), {
+		cwd,
+		absolute: false
+	});
+};
+const getPackages = (cwd) => {
+	return scanWorkspacePackages(cwd).reduce(((acc, file) => {
+		const workspace = dirname(dirname(file));
+		(acc[workspace] ??= []).push(basename(dirname(file)));
+		return acc;
+	}), {});
+};
+const monoConfig = (packages = [], workspace = "packages") => {
+	const subs = isEmpty(packages) ? "[]" : `[ ${[...packages].map((k) => `'${k}'`).join(", ")} ]`;
+	return dedent(`
+    import { defineConfig } from '@peiyanlu/release'
+    ${newline(1)}
+    export default defineConfig({
+      isMonorepo: true,
+      packages: ${subs},
+      getPkgDir: (pkg) => \`${workspace}/\${ pkg }\`,
+      toTag: (pkg, version) => \`\${ pkg }@\${ version }\`,
+      changelog: {
+        tagPrefix: (pkg) => \`\${ pkg }@\`,
+      },
+    })
+  `);
+};
+const generateMonoConfig = (cwd = process.cwd()) => {
+	const entries = Object.entries(getPackages(cwd));
+	const [workspace, packages] = entries.length === 1 ? entries[0] : [];
+	return monoConfig(packages, workspace);
+};
+//#endregion
 //#region src/cli.ts
 program.name("release").description(description).version(version, "-v, --version", "Print the tool version and exit.").usage("[release-type] [options]").argument("[release-type]", "Version bump type: patch | minor | major").enablePositionalOptions().option("-n, --dry-run", "Run in dry mode", false).option("-p, --package <pkg>", "Specify package name (Mono-repo CI only).", "").option("--otp <code>", "One-time password for npm publish.", "").option("--prepare", "Prepare a release.", false).option("--ci", "Enable CI mode.", false).option("--show-changelog", "Print changelog and exit.", false).option("--show-release", "Print release version and exit.", false).option("--only-changelog", "Only update the changelog.", false).option("-r, --release-count <count>", "Release count for release.", (val) => Number(val)).option("--include-hidden", "Include hidden commit types in the changelog.").option("-C, --no-require-clean-working-tree", "Allow releasing with uncommitted changes.").option("--skip-git", "Skip all Git-related checks and operations.").option("--skip-npm", "Skip all npm-related checks and operations.").option("--skip-github", "Skip all GitHub-related checks and operations.").option("-m, --is-monorepo", "Mono-repo project").helpOption("-h, --help", "Display help information.").action(async (releaseType, options) => {
 	const { prepare } = options;
@@ -1417,16 +1466,12 @@ program.command("init").description("Create a release configuration file").optio
 		console.error(`${red`Error:`} ${yellow(infile)} already exists.\nUse ${green`--force`} to overwrite.`);
 		process.exit(1);
 	}
-	const monoConfigToString = () => `{
-  isMonorepo: true,
-  packages: [],
-  getPkgDir: (pkg) => \`packages/\${ pkg }\`,
-  toTag: (pkg, version) => \`\${ pkg }@\${ version }\`,
-  changelog: {
-    tagPrefix: (pkg) => \`\${ pkg }@\`,
-  },
-}`;
-	const content = [`import { defineConfig } from '@peiyanlu/release'`, `export default defineConfig(${monorepo ? monoConfigToString() : "{}"})`].join(eol(3));
+	const config = () => dedent(`
+      import { defineConfig } from '@peiyanlu/release'
+      ${newline(1)}
+      export default defineConfig({})
+    `);
+	const content = monorepo ? generateMonoConfig(process.cwd()) : config();
 	writeFileSync(configFile, content + newline(), "utf-8");
 	console.log(`Wrote to ${underline(dim(configFile))}`);
 	if (add) gitAddSync([infile]);

package/dist/index.d.mts

@@ -19,20 +19,20 @@ type HookConfig = { [key in ReleaseHookKey]: ReleaseHookValue; };
 interface ReleaseConfig {
   /**
    * 生命周期钩子配置
-   * 用于在 Release 关键阶段注入自定义逻辑（如 before/after hooks）。
+   * 用于在 Release 关键阶段注入自定义逻辑（如 before/after hooks）
    */
   hooks: HookConfig;
   /** 是否是 monorepo */
   isMonorepo: boolean;
-  /** 使用 monorepo 时发布的包列表，后续回调的 `pkg`。默认为 `[]` 作为单仓库 */
+  /** 使用 monorepo 时发布的包列表，后续回调的 `pkg`，默认为 `[]` 作为单仓库 */
   packages: string[];
-  /** 使用 monorepo 时使用 getPkgDir，例如 `packages/${pkg}`。 默认为 `.` 作为单仓库 */
+  /** 使用 monorepo 时使用 getPkgDir，例如 `packages/${pkg}`，默认为 `.` 作为单仓库 */
   getPkgDir: (pkg: string) => string;
   /** 使用 monorepo 时使用 toTag，例如 `${pkg}@${version}`，默认为 `v${version}` 作为单仓库 */
   toTag: (pkg: string, version: string) => string;
   /**
    * CHANGELOG 相关配置
-   * 影响生成的日志数量、日志标题（monorepo）。
+   * 影响生成的日志数量、日志标题（monorepo）
    */
   changelog: {
     /**
@@ -60,7 +60,7 @@ interface ReleaseConfig {
   skipGithub: boolean;
   /**
    * Git 相关配置
-   * 影响提交、打 tag、推送等本地/远程 Git 行为。
+   * 影响提交、打 tag、推送等本地/远程 Git 行为
    */
   git: {
     /**
@@ -115,7 +115,7 @@ interface ReleaseConfig {
   };
   /**
    * NPM 发布相关配置
-   * 影响 npm publish 的目标路径、参数与前置校验。
+   * 影响 npm publish 的目标路径、参数与前置校验
    */
   npm: {
     /**
@@ -129,19 +129,19 @@ interface ReleaseConfig {
     /**
      * 是否跳过发布前检查（如 ping、whoami 等校验）
      *
-     * 启用后可减少发布前的网络请求，但可能无法提前发现登录状态异常或 Registry 不可用等问题。
+     * 启用后可减少发布前的网络请求，但可能无法提前发现登录状态异常或 Registry 不可用等问题
      */
     skipChecks: boolean;
     /**
      * 发布前的文件清理配置
      *
-     * 用于控制复制到临时发布目录后的清理行为，不会修改源项目文件。
+     * 用于控制复制到临时发布目录后的清理行为，不会修改源项目文件
      */
     cleanup: {
       /**
        * 是否清理 package.json
        *
-       * 包括移除开发相关字段、应用 publishConfig，并保留发布所需内容。
+       * 包括移除开发相关字段、应用 publishConfig，并保留发布所需内容
        */
       packageJson: boolean | {
         /** 需要忽略的字段，支持 `a.b.c` */
@@ -152,7 +152,7 @@ interface ReleaseConfig {
       /**
        * 是否清理 README.md
        *
-       * 仅保留主要内容，并移除或精简不需要随包发布的文档内容。
+       * 仅保留主要内容，并移除或精简不需要随包发布的文档内容
        */
       readme: boolean;
       /**
@@ -164,7 +164,7 @@ interface ReleaseConfig {
   /**
    * GitHub Release 相关配置
    *
-   * 控制是否创建 Release、发布方式以及上传资源。
+   * 控制是否创建 Release、发布方式以及上传资源
    */
   github: {
     /**
@@ -196,9 +196,13 @@ interface ReleaseConfig {
      */
     assets: string[];
     /**
-     * 是否跳过 GitHub 发布前检查
+     * 是否跳过本地 GitHub 发布前检查
      */
     skipChecks: boolean;
+    /**
+     * 是否使用简短的 Release Notes，内容为指向 CHANGELOG.md 的链接
+     */
+    shortNotes: boolean;
   };
 }
 //#endregion
@@ -230,6 +234,8 @@ interface ParsePresetOptions {
   includeHidden?: boolean;
   /** 对默认 commit types 进行转换 */
   transformTypes?: (types: CommitType$1[]) => CommitType$1[];
+  /** commit scope */
+  scope?: string | string[];
 }
 type GOptions = Simplify<GenerateOptions & ParsePresetOptions>;
 declare const createGenerator: (options: GOptions) => Promise<ConventionalChangelog>;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { isFunction, isPlainObject, isUndefined, isZero } from "@peiyanlu/ts-utils";
+import { isEmpty, isFunction, isPlainObject, isUndefined, isZero } from "@peiyanlu/ts-utils";
 import { createWriteStream, existsSync, readFileSync } from "node:fs";
 import { join } from "node:path";
 import { eol, getPackageInfo, publishPackage, resolvePublishTag } from "@peiyanlu/cli-utils";
@@ -154,6 +154,10 @@ function headerPartial(context) {
 	const fullTitle = words(linkCompare && !isLikelyHash(previousTag) ? link(version, compareUrl(context)) : version, title && `"${title}"`, date && `(${date})`);
 	return heading(2, isPatch ? small(fullTitle) : fullTitle);
 }
+function preamblePartial(contest) {
+	const { preamble, commitGroups, noteGroups } = contest;
+	return segments(preamble, isEmpty(preamble) && isEmpty(commitGroups) && isEmpty(noteGroups) && "Version bump without any changes.");
+}
 function template(context) {
 	const { headerPartial, preamblePartial, commitPartial, footerPartial, noteGroups, commitGroups } = context;
 	return segments(headerPartial(context), preamblePartial(context), each(noteGroups, (group) => segments(heading(3, words("⚠", group.title)), list(group.notes, (note) => {
@@ -163,24 +167,29 @@ function template(context) {
 //#endregion
 //#region src/git/changelog.ts
 const parsePreset = (options = {}) => {
-	const { includeHidden, transformTypes } = options;
+	const { includeHidden, transformTypes, scope } = options;
 	let types = [...defaultTypes];
 	if (includeHidden) types.forEach((type) => {
 		if (type.effect === "hidden") type.effect = "changelog";
 	});
 	types = transformTypes?.(types) ?? types;
-	const preset = createPreset({ types });
+	const preset = createPreset({
+		types,
+		scope
+	});
 	preset.writer ??= {};
+	preset.writer.preamblePartial = preamblePartial;
 	preset.writer.headerPartial = headerPartial;
 	preset.writer.template = template;
 	return preset;
 };
 const createGenerator = async (options) => {
-	const { getPkgDir, tagPrefix, releaseCount = 1, includeHidden, transformTypes } = options;
+	const { getPkgDir, tagPrefix, releaseCount = 1, includeHidden, transformTypes, scope } = options;
 	const pkgDir = getPkgDir();
 	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(parsePreset({
 		includeHidden,
-		transformTypes
+		transformTypes,
+		scope
 	})).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
 };
 const getChangelog = async (options) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/release",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Release project tool.",
   "license": "MIT",
   "type": "module",
@@ -24,7 +24,7 @@
     "@conventional-changelog/template": "^1.2.1",
     "@octokit/rest": "^22.0.1",
     "@peiyanlu/cli-utils": "^0.0.15",
-    "@peiyanlu/node-utils": "^0.0.3",
+    "@peiyanlu/node-utils": "^0.0.4",
     "@peiyanlu/ts-utils": "^0.0.12",
     "ansis": "^4.3.1",
     "commander": "^15.0.0",
@@ -36,7 +36,8 @@
     "open": "^11.0.0",
     "publint": "^0.3.22",
     "semver": "^7.8.5",
-    "tinyglobby": "^0.2.17"
+    "tinyglobby": "^0.2.17",
+    "yaml": "^2.9.0"
   },
   "author": {
     "name": "YanluPei",