@peiyanlu/release 1.0.0 → 1.1.1

package/README.md

@@ -56,14 +56,21 @@ pnpm release minor --ci
 
 ### 通用参数
 
-| 参数                 | 说明                                                         |
-|--------------------|------------------------------------------------------------|
-| `-v, --version`    | 输出当前 CLI 版本并退出                                             |
-| `-h, --help`       | 显示帮助信息                                                     |
-| `-n, --dry-run`    | 空跑模式，展示将要执行的发布流程但不做任何修改                                    |
-| `--show-release`   | 打印即将发布的版本号并退出                                              |
-| `--show-changelog` | 打印生成的 Changelog 并退出                                        |
-| `--ci`             | 启用 CI 模式：禁用交互提示，缺少必要参数时直接失败；GitHub Actions 等 CI/CD 环境中默认启用 |
+| 参数                                    | 说明                                                         |
+|---------------------------------------|------------------------------------------------------------|
+| `-v, --version`                       | 输出当前 CLI 版本并退出                                             |
+| `-h, --help`                          | 显示帮助信息                                                     |
+| `-n, --dry-run`                       | 空跑模式，展示将要执行的发布流程但不做任何修改                                    |
+| `--show-release`                      | 打印即将发布的版本号并退出                                              |
+| `--show-changelog`                    | 打印生成的 Changelog 并退出                                        |
+| `--ci`                                | 启用 CI 模式：禁用交互提示，缺少必要参数时直接失败；GitHub Actions 等 CI/CD 环境中默认启用 |
+| `-r, --release-count <count>`         | 生成多少个版本的变更日志                                               |
+| `--include-hidden`                    | 生成 CHANGELOG 时包含默认隐藏的 commit 类型                            |
+| `--only-changelog`                    | 仅更新 CHANGELOG                                              |
+| `-C, --no-require-clean-working-tree` | 是否要求工作目录保持干净（无未提交的更改）                                      |
+| `--skip-git`                          | 跳过 git、github 环境检查以及后续操作                                   |
+| `--skip-npm`                          | 跳过 npm 环境检查以及后续操作                                          |
+| `--skip-github`                       | 跳过 github 环境检查以及后续操作                                       |
 
 ### Prepare 相关参数
 
@@ -81,6 +88,7 @@ pnpm release minor --prepare --ci --package pkg-a
 
 | 参数                    | 说明                               |
 |-----------------------|----------------------------------|
+| `-m, --is-monorepo`   | Monorepo 项目                      |
 | `-p, --package <pkg>` | 指定要发布的子包名称（仅用于 Monorepo 的 CI 场景） |
 
 ```bash
@@ -194,6 +202,7 @@ release init
 |------------------|---------------------|
 | `-f, --force`    | 覆盖已存在的配置文件          |
 | `-m, --monorepo` | 生成 Monorepo 项目的配置模板 |
+| `-a, --add`      | 自动暂存配置文件            |
 
 #### 行为说明
 
@@ -232,6 +241,12 @@ COMMIT_TYPES：
 - 默认：`feat | feature | fix | perf | revert | docs | style | chore | refactor | test | build | ci`
 - 自定义：`config | deps | security | i18n | ux | hotfix`
 
+| Effect          | Types                                                          | 说明                                |
+|-----------------|----------------------------------------------------------------|-----------------------------------|
+| **`bump`**      | `feat`, `feature`, `fix`, `perf`, `revert`                     | 影响版本号（Minor/Patch），同时写入 CHANGELOG |
+| **`changelog`** | `docs`, `refactor`, `deps`, `security`, `hotfix`, `i18n`, `ux` | 不影响版本号，仅写入 CHANGELOG              |
+| **`hidden`**    | `style`, `chore`, `test`, `build`, `ci`, `config`, `tool`      | 不影响版本号，也不会写入 CHANGELOG            |
+
 支持 **--show-changelog** 预览模式：
 
 - 仅展示用于生成 Changelog 的 Commits

package/dist/cli.mjs

@@ -12,8 +12,10 @@ import { inc, neq } from "semver";
 import { inspect } from "node:util";
 import { ConventionalChangelog } from "conventional-changelog";
 import createPreset from "conventional-changelog-conventionalcommits";
+import { Bumper } from "conventional-recommended-bump";
 import { writeFile } from "node:fs/promises";
 import { finished } from "node:stream/promises";
+import { bold, compareUrl, each, heading, link, list, newline, segments, small, words } from "@conventional-changelog/template";
 import { Octokit } from "@octokit/rest";
 import { contentType } from "mime-types";
 import open from "open";
@@ -79,7 +81,8 @@ const MSG = {
 		SHOW_VERSION: (version) => `🎉  Released ${green(version)}`,
 		SHOW_CHANGELOG: "🎉  Changelog collected",
 		CHANGELOG_EMPTY: "No commits found since last release",
-		CHANGES_EMPTY: "Working tree clean. No files changed"
+		CHANGES_EMPTY: "Working tree clean. No files changed",
+		ONLY_CHANGELOG: "🎉  Changelog generation completed"
 	},
 	CHECK: {
 		GIT: {
@@ -306,7 +309,7 @@ const option = (label, value, hint) => ({
 	value,
 	hint: hint ?? value
 });
-const runVersionPrompts = async (ctx, config) => {
+const runVersionPrompts = async (ctx, config, inferred) => {
 	const { pkg: { current, fromPreRelease } } = ctx;
 	const selectVersion = async () => {
 		const versions = createVersionMap(current);
@@ -326,7 +329,7 @@ const runVersionPrompts = async (ctx, config) => {
 		const type = await select({
 			message: question(MSG.PROMPT.SELECT_VERSION, "version"),
 			options,
-			initialValue: fromPreRelease ? "prerelease" : "patch"
+			initialValue: inferred ?? (fromPreRelease ? "prerelease" : "patch")
 		});
 		abortSinglePrompt(type);
 		return type;
@@ -357,6 +360,7 @@ const createDefaultContext = () => {
 		release: false,
 		showRelease: false,
 		showChangelog: false,
+		onlyChangelog: false,
 		dryRun: false,
 		noGit: false,
 		noNpm: false,
@@ -436,7 +440,9 @@ const createDefaultConfig = (isCI) => {
 			tagPrefix(pkg) {
 				return "";
 			},
-			releaseCount: 1
+			releaseCount: 1,
+			includeHidden: false,
+			transformTypes: (t) => t
 		},
 		skipGit: false,
 		skipNpm: false,
@@ -478,179 +484,178 @@ const defaultTypes = [
 	{
 		type: "feat",
 		section: "✨ 新功能",
+		effect: "bump",
 		description: "新增功能"
 	},
 	{
 		type: "feature",
 		section: "✨ 新功能",
+		effect: "bump",
 		description: "新增功能"
 	},
 	{
 		type: "fix",
 		section: "🐛 Bug 修复",
+		effect: "bump",
 		description: "修复 bug"
 	},
 	{
 		type: "perf",
 		section: "⚡ 性能优化",
+		effect: "bump",
 		description: "提升性能"
 	},
 	{
 		type: "revert",
 		section: "⏪ 回退",
+		effect: "bump",
 		description: "回退到之前版本"
 	},
 	{
 		type: "docs",
 		section: "📝 文档",
+		effect: "changelog",
 		description: "文档更新"
 	},
 	{
 		type: "style",
 		section: "💄 样式调整",
+		effect: "hidden",
 		description: "样式或格式修改"
 	},
 	{
 		type: "chore",
 		section: "🧹 其他更新",
+		effect: "hidden",
 		description: "非功能性更改"
 	},
 	{
 		type: "refactor",
 		section: "♻️ 代码重构",
+		effect: "changelog",
 		description: "重构代码"
 	},
 	{
 		type: "test",
 		section: "🧪 测试",
+		effect: "hidden",
 		description: "测试更新"
 	},
 	{
 		type: "build",
 		section: "🏗️ 构建系统",
+		effect: "hidden",
 		description: "构建工具和系统修改"
 	},
 	{
 		type: "ci",
 		section: "🤖 CI",
+		effect: "hidden",
 		description: "持续集成配置"
 	},
-	{
-		type: "config",
-		section: "⚙️ 配置",
-		description: "配置文件更新"
-	},
 	{
 		type: "deps",
 		section: "📦 依赖更新",
+		effect: "changelog",
 		description: "依赖版本变更"
 	},
 	{
 		type: "security",
 		section: "🛡️ 安全修复",
+		effect: "changelog",
 		description: "安全性更新"
 	},
+	{
+		type: "hotfix",
+		section: "🚑 热修复",
+		effect: "changelog",
+		description: "紧急修复"
+	},
 	{
 		type: "i18n",
 		section: "🌐 国际化",
+		effect: "changelog",
 		description: "国际化相关更新"
 	},
 	{
 		type: "ux",
 		section: "🎨 用户体验",
+		effect: "changelog",
 		description: "用户体验改进"
 	},
 	{
-		type: "hotfix",
-		section: "🚑 热修复",
-		description: "紧急修复"
+		type: "config",
+		section: "⚙️ 配置",
+		effect: "hidden",
+		description: "配置文件更新"
 	},
 	{
 		type: "tool",
 		section: "🛠️ 工具链",
+		effect: "hidden",
 		description: "工具链变更"
 	}
 ];
 //#endregion
+//#region src/git/templates.ts
+const isLikelyHash = (value) => /^[0-9a-f]{7,40}$/i.test(value);
+function headerPartial(context) {
+	const { isPatch, linkCompare, version, title, date, previousTag } = context;
+	const fullTitle = words(linkCompare && !isLikelyHash(previousTag) ? link(version, compareUrl(context)) : version, title && `"${title}"`, date && `(${date})`);
+	return heading(2, isPatch ? small(fullTitle) : fullTitle);
+}
+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) => {
+		return each([words(note.commit.scope && bold(`${note.commit.scope}:`), commitPartial(context, note.commit)), note.commit.subject.trim() !== note.text.trim() ? list([note.text], (t) => t) : ""], (t) => t, newline());
+	})), newline(2)), each(commitGroups, (group) => segments(group.title && heading(3, group.title), list(group.commits, (commit) => commitPartial(context, commit))), newline(2)), footerPartial(context));
+}
+//#endregion
 //#region src/git/changelog.ts
-const parsePreset = async () => {
-	const preset = await createPreset({ types: defaultTypes.map((t) => ({
-		...t,
-		hidden: false
-	})) });
+const parsePreset = (options = {}) => {
+	const { includeHidden, transformTypes } = options;
+	let types = [...defaultTypes];
+	if (includeHidden) types.forEach((type) => {
+		if (type.effect === "hidden") type.effect = "changelog";
+	});
+	types = transformTypes?.(types) ?? types;
+	const preset = createPreset({ types });
 	preset.writer ??= {};
-	preset.writer.headerPartial = `## {{#if isPatch~}} <small> {{~/if~}}
-{{#if @root.linkCompare~}}
-[{{version}}](
-{{~#if @root.repository~}}
-  {{~#if @root.host}}
-    {{~@root.host}}/
-  {{~/if}}
-  {{~#if @root.owner}}
-    {{~@root.owner}}/
-  {{~/if}}
-  {{~@root.repository}}
-{{~else}}
-  {{~@root.repoUrl}}
-{{~/if~}}
-/compare/{{previousTag}}...{{currentTag}})
-{{~else}}
-{{~version}}
-{{~/if}}
-{{~#if title}} "{{title}}"
-{{~/if}}
-{{~#if date}} ({{date}})
-{{~/if}}
-{{~#if isPatch~}} </small> {{~/if}}
-`.trim() + eol();
-	preset.writer.mainTemplate = `{{> header}}
-{{#if noteGroups}}
-{{#each noteGroups}}
-
-### ⚠ {{title}}
-
-{{#each notes}}
-* {{#if commit.scope}}**{{commit.scope}}:** {{/if}}{{commit.subject}} {{#if commit.hash}}([{{commit.shortHash}}](https://github.com/{{@root.owner}}/{{@root.repository}}/commit/{{commit.hash}})){{/if}}
-{{/each}}
-{{/each}}
-{{/if}}
-{{#each commitGroups}}
-
-{{#if title}}
-### {{title}}
-
-{{/if}}
-{{#each commits}}
-{{> commit root=@root}}
-{{/each}}
-{{/each}}`.trim();
+	preset.writer.headerPartial = headerPartial;
+	preset.writer.template = template;
 	return preset;
 };
-const createGenerator = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
+const inferReleaseType = async (options) => {
+	const preset = parsePreset(options);
+	const res = await new Bumper().config(preset).bump(preset.whatBump);
+	if (!("releaseType" in res)) return void 0;
+	const { releaseType, reason } = res;
+	return options?.json ? {
+		releaseType,
+		reason
+	} : releaseType;
+};
+const createGenerator = async (options) => {
+	const { getPkgDir, tagPrefix, releaseCount = 1, includeHidden, transformTypes } = options;
 	const pkgDir = getPkgDir();
-	const preset = await parsePreset();
-	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(preset).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
+	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(parsePreset({
+		includeHidden,
+		transformTypes
+	})).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
 };
-const getChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
-	const generator = await createGenerator({
-		getPkgDir,
-		tagPrefix,
-		releaseCount
-	});
+const getChangelog = async (options) => {
+	const generator = await createGenerator(options);
 	let changelog = "";
 	for await (const chunk of generator.write()) changelog += chunk;
 	return changelog.trimEnd();
 };
-const generateChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
+const generateChangelog = async (options) => {
+	const { getPkgDir, releaseCount = 1 } = options;
 	const infile = join(getPkgDir(), "CHANGELOG.md");
 	if (!existsSync(infile)) await writeFile(infile, "");
 	const exist = readFileSync(infile, "utf-8");
 	const writeStream = createWriteStream(infile);
-	const generator = await createGenerator({
-		getPkgDir,
-		tagPrefix,
-		releaseCount
-	});
+	const generator = await createGenerator(options);
 	for await (const chunk of generator.write()) writeStream.write(chunk);
 	const override = isZero(releaseCount);
 	if (!(isZero(exist.trim().length) || override)) {
@@ -981,16 +986,17 @@ var Action = class {
 	async createContext(cmdArgs, options, prepare = false) {
 		const { version: cVersion, name: cName } = readJsonFile(join(__dirname, "../package.json"));
 		const { otp, package: defPkg, releaseCount, ...others } = options;
-		const { showChangelog, showRelease, ci, dryRun } = mapObjectValues(others, (v) => Boolean(v));
+		const { showChangelog, showRelease, ci, dryRun, onlyChangelog } = mapObjectValues(others, (v) => Boolean(v));
 		process.env["dryRun"] = String(dryRun);
 		const { configFile, config: local } = await resolveConfig(process.cwd());
 		const config = mergeConfig(createDefaultConfig(ci ? true : void 0), local);
 		info(MSG.INFO.TOOL(cName, cVersion));
 		info(MSG.INFO.CONFIG(configFile));
 		{
-			const { requireCleanWorkingTree, skipGit, skipNpm, skipGithub, isMonorepo } = mapObjectValues(others, (v) => Boolean(v));
+			const { requireCleanWorkingTree, skipGit, skipNpm, skipGithub, isMonorepo, includeHidden } = mapObjectValues(others, (v) => Boolean(v));
 			const count = Number(releaseCount);
 			config.changelog.releaseCount = isNaN(count) ? 0 : count;
+			config.changelog.includeHidden = includeHidden;
 			config.git.requireCleanWorkingTree = requireCleanWorkingTree;
 			config.skipGit = skipGit;
 			config.skipNpm = skipNpm;
@@ -1026,6 +1032,7 @@ var Action = class {
 			dryRun,
 			showRelease,
 			showChangelog,
+			onlyChangelog,
 			npm: { otp: String(otp) },
 			increment: cmdArgs,
 			isIncrement: true,
@@ -1057,8 +1064,32 @@ var Action = class {
 			config
 		};
 	}
+	async printChangelog(ctx, config) {
+		const { showChangelog, selectedPkg, noGit, isIncrement } = ctx;
+		const { isMonorepo, getPkgDir, changelog: { tagPrefix, releaseCount, includeHidden, transformTypes } } = config;
+		if (noGit) return;
+		const match = isMonorepo ? `${tagPrefix?.(selectedPkg)}*` : "*";
+		const { from, to } = isZero(releaseCount) ? {
+			from: "",
+			to: "HEAD"
+		} : await resolveChangelogRange(isIncrement, match);
+		const commits = await getLogSince(from, to, getPkgDir(selectedPkg));
+		const changelog = await getChangelog({
+			getPkgDir: () => getPkgDir(selectedPkg),
+			tagPrefix: tagPrefix?.(selectedPkg),
+			releaseCount,
+			includeHidden,
+			transformTypes
+		});
+		Object.assign(ctx.github, { changelog });
+		if (commits) {
+			msg("GIT", `Changelog(${from}...${to}):${eol(2)}` + changelog);
+			msg("GIT", `Commits(${from}...${to}):${eol(2)}` + commits);
+			if (showChangelog) taskEnd(MSG.LOG.SHOW_CHANGELOG);
+		} else msg("GIT", MSG.LOG.CHANGELOG_EMPTY);
+	}
 	async checkTask(ctx, config) {
-		const { dryRun } = ctx;
+		const { dryRun, onlyChangelog } = ctx;
 		await tasks([
 			{
 				title: MSG.CHECK.GIT.CHECKING,
@@ -1075,7 +1106,7 @@ var Action = class {
 					const { pkg: { publishConfig: { registry } } } = ctx;
 					return success(MSG.CHECK.NPM.CHECKED(registry, msg), dryRun);
 				},
-				enabled: !ctx.noNpm
+				enabled: !(ctx.noNpm || onlyChangelog)
 			},
 			{
 				title: MSG.CHECK.GITHUB.CHECKING,
@@ -1085,19 +1116,27 @@ var Action = class {
 					const repository = getGithubUrl(owner, repo);
 					return success(MSG.CHECK.GITHUB.CHECKED(repository, msg), dryRun);
 				},
-				enabled: !ctx.noGitHub
+				enabled: !(ctx.noGitHub || onlyChangelog)
 			}
 		]).catch(abortOnError);
 	}
 	async bumpTask(ctx, config) {
-		const { pkg: { current }, dryRun, isCI, showRelease, showChangelog, selectedPkg, noGit } = ctx;
-		const { isMonorepo, hooks, getPkgDir, changelog: { tagPrefix, releaseCount } } = config;
+		const { pkg: { current }, dryRun, isCI, showRelease, selectedPkg, onlyChangelog } = ctx;
+		const { hooks, getPkgDir, changelog: { includeHidden, transformTypes } } = config;
+		if (onlyChangelog) return;
 		const need = (ctx) => {
 			const { pkg: { next }, isIncrement } = ctx;
 			return !next && isIncrement;
 		};
 		if (need(ctx)) {
-			const nextVersion = (isCI ? inc(current, "patch") : void 0) || await runVersionPrompts(ctx, config);
+			const res = await inferReleaseType({
+				includeHidden,
+				transformTypes,
+				json: true
+			});
+			if (res) msg("BUMP", res.reason);
+			const inferred = res?.releaseType;
+			const nextVersion = (isCI ? inferred ?? inc(current, "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, {
@@ -1107,7 +1146,7 @@ var Action = class {
 				preBase
 			});
 		}
-		const { pkg: { next }, isIncrement } = ctx;
+		const { pkg: { next } } = ctx;
 		if (showRelease) taskEnd(MSG.LOG.SHOW_VERSION(next));
 		await runLifeCycleHook(hooks, "before:bump", dryRun);
 		await tasks([{
@@ -1117,31 +1156,15 @@ var Action = class {
 				await formatTemplate(ctx, config);
 				const to = `(${current}...${diff(current, next)})`;
 				return success(MSG.TASK.VERSION.END(to), dryRun);
-			}
+			},
+			enabled: true
 		}]).catch((err) => abortOnError(err, ctx));
 		await runLifeCycleHook(hooks, "after:bump", dryRun);
-		if (noGit) return;
-		const match = isMonorepo ? `${tagPrefix?.(selectedPkg)}*` : "*";
-		const { from, to } = isZero(releaseCount) ? {
-			from: "",
-			to: "HEAD"
-		} : await resolveChangelogRange(isIncrement, match);
-		const commits = await getLogSince(from, to, getPkgDir(selectedPkg));
-		const changelog = await getChangelog({
-			getPkgDir: () => getPkgDir(selectedPkg),
-			tagPrefix: tagPrefix?.(selectedPkg),
-			releaseCount
-		});
-		Object.assign(ctx.github, { changelog });
-		if (commits) {
-			msg("GIT", `Changelog(${from}...${to}):${eol(2)}` + changelog);
-			msg("GIT", `Commits(${from}...${to}):${eol(2)}` + commits);
-			if (showChangelog) taskEnd(MSG.LOG.SHOW_CHANGELOG);
-		} else msg("GIT", MSG.LOG.CHANGELOG_EMPTY);
+		await this.printChangelog(ctx, config);
 	}
 	async changelogTask(ctx, config) {
-		const { isIncrement, dryRun, selectedPkg, noGit } = ctx;
-		const { getPkgDir, changelog: { tagPrefix, releaseCount } } = config;
+		const { isIncrement, dryRun, selectedPkg, noGit, onlyChangelog } = ctx;
+		const { getPkgDir, changelog: { tagPrefix, releaseCount, includeHidden, transformTypes } } = config;
 		if (noGit) return;
 		await tasks([{
 			title: MSG.TASK.CHANGELOG.START,
@@ -1149,7 +1172,9 @@ var Action = class {
 				await generateChangelog({
 					getPkgDir: () => getPkgDir(selectedPkg),
 					tagPrefix: tagPrefix?.(selectedPkg),
-					releaseCount
+					releaseCount,
+					includeHidden,
+					transformTypes
 				});
 				await gitAddAll();
 				return success(MSG.TASK.CHANGELOG.END, dryRun);
@@ -1159,6 +1184,7 @@ var Action = class {
 		const changeset = await getShortStatus();
 		if (changeset) msg("GIT", `Changes:${eol(2)}` + coloredStatus(changeset));
 		else msg("GIT", MSG.LOG.CHANGES_EMPTY);
+		if (onlyChangelog) taskEnd(MSG.LOG.ONLY_CHANGELOG);
 	}
 	async gitTask(ctx, config) {
 		const { noGit, dryRun } = ctx;
@@ -1220,7 +1246,7 @@ var Action = class {
 //#endregion
 //#region src/cli.ts
 const pkg = readJsonFile(join(__dirname, "..", "package.json"));
-program.name("release").description(pkg.description).version(pkg.version, "-v, --version", "Print the tool version and exit.").usage("[release-type] [options]").argument("[release-type]", "Version bump type: patch | minor | major").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("-r, --release-count <count>", "Release count for release.", (value) => Number(value), 1).option("-C, --no-require-clean-working-tree", "Allow releasing with uncommitted changes.", true).option("-m, --is-monorepo", "Mono-repo project", false).option("--skip-git", "Skip all Git-related checks and operations.", false).option("--skip-npm", "Skip all npm-related checks and operations.", false).option("--skip-github", "Skip all GitHub-related checks and operations.", false).helpOption("-h, --help", "Display help information.").action(async (releaseType, options) => {
+program.name("release").description(pkg.description).version(pkg.version, "-v, --version", "Print the tool version and exit.").usage("[release-type] [options]").argument("[release-type]", "Version bump type: patch | minor | major").option("-n, --dry-run", "Run in dry mode", false).option("-m, --is-monorepo", "Mono-repo project", 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("-r, --release-count <count>", "Release count for release.", (value) => Number(value), 1).option("--include-hidden", "Include hidden commit types in the changelog.", false).option("--only-changelog", "Only update the changelog.", false).option("-C, --no-require-clean-working-tree", "Allow releasing with uncommitted changes.", true).option("--skip-git", "Skip all Git-related checks and operations.", false).option("--skip-npm", "Skip all npm-related checks and operations.", false).option("--skip-github", "Skip all GitHub-related checks and operations.", false).helpOption("-h, --help", "Display help information.").action(async (releaseType, options) => {
 	const { prepare } = options;
 	const action = new Action();
 	prepare ? await action.handlePrepareRelease(releaseType, options) : await action.handleRelease(releaseType, options);

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { DeepPartial, DeepRequired } from "@peiyanlu/ts-utils";
 import { ConventionalChangelog } from "conventional-changelog";
+import { CommitType } from "conventional-changelog-conventionalcommits";
 import { log } from "@clack/prompts";
 
 //#region src/types.d.ts
@@ -36,6 +37,14 @@ interface ReleaseConfig {
      * 生成多少个版本的变更日志，详见 {@link Options}
      */
     releaseCount: number;
+    /**
+     * 生成 CHANGELOG 时包含默认隐藏的 commit 类型
+     */
+    includeHidden: boolean;
+    /**
+     * 对默认 commit types 进行转换
+     */
+    transformTypes: (types: CommitType[]) => CommitType[];
   };
   /** 跳过 git、github 环境检查以及后续操作  */
   skipGit: boolean;
@@ -179,21 +188,15 @@ interface GenerateOptions {
   /** 生成多少个变更日志，详见 {@link Options} */
   releaseCount?: number;
 }
-declare const createGenerator: ({
-  getPkgDir,
-  tagPrefix,
-  releaseCount
-}: GenerateOptions) => Promise<ConventionalChangelog>;
-declare const getChangelog: ({
-  getPkgDir,
-  tagPrefix,
-  releaseCount
-}: GenerateOptions) => Promise<string>;
-declare const generateChangelog: ({
-  getPkgDir,
-  tagPrefix,
-  releaseCount
-}: GenerateOptions) => Promise<void>;
+interface ParsePresetOptions {
+  /** 生成 CHANGELOG 时包含默认隐藏的 commit 类型 */
+  includeHidden?: boolean;
+  /** 对默认 commit types 进行转换 */
+  transformTypes?: (types: CommitType[]) => CommitType[];
+}
+declare const createGenerator: (options: GenerateOptions & ParsePresetOptions) => Promise<ConventionalChangelog>;
+declare const getChangelog: (options: GenerateOptions & ParsePresetOptions) => Promise<string>;
+declare const generateChangelog: (options: GenerateOptions & ParsePresetOptions) => Promise<void>;
 //#endregion
 //#region src/npm/publish.d.ts
 interface PublishTagOptions {

package/dist/index.mjs

@@ -4,8 +4,10 @@ import { join } from "node:path";
 import { eol, getPackageInfo, publishPackage, resolvePublishTag } from "@peiyanlu/cli-utils";
 import { ConventionalChangelog } from "conventional-changelog";
 import createPreset from "conventional-changelog-conventionalcommits";
+import "conventional-recommended-bump";
 import { writeFile } from "node:fs/promises";
 import { finished } from "node:stream/promises";
+import { bold, compareUrl, each, heading, link, list, newline, segments, small, words } from "@conventional-changelog/template";
 import { blue, cyan, green, magenta, red, underline, yellow } from "ansis";
 //#region src/config.ts
 function defineConfig(config) {
@@ -31,179 +33,168 @@ const defaultTypes = [
 	{
 		type: "feat",
 		section: "✨ 新功能",
+		effect: "bump",
 		description: "新增功能"
 	},
 	{
 		type: "feature",
 		section: "✨ 新功能",
+		effect: "bump",
 		description: "新增功能"
 	},
 	{
 		type: "fix",
 		section: "🐛 Bug 修复",
+		effect: "bump",
 		description: "修复 bug"
 	},
 	{
 		type: "perf",
 		section: "⚡ 性能优化",
+		effect: "bump",
 		description: "提升性能"
 	},
 	{
 		type: "revert",
 		section: "⏪ 回退",
+		effect: "bump",
 		description: "回退到之前版本"
 	},
 	{
 		type: "docs",
 		section: "📝 文档",
+		effect: "changelog",
 		description: "文档更新"
 	},
 	{
 		type: "style",
 		section: "💄 样式调整",
+		effect: "hidden",
 		description: "样式或格式修改"
 	},
 	{
 		type: "chore",
 		section: "🧹 其他更新",
+		effect: "hidden",
 		description: "非功能性更改"
 	},
 	{
 		type: "refactor",
 		section: "♻️ 代码重构",
+		effect: "changelog",
 		description: "重构代码"
 	},
 	{
 		type: "test",
 		section: "🧪 测试",
+		effect: "hidden",
 		description: "测试更新"
 	},
 	{
 		type: "build",
 		section: "🏗️ 构建系统",
+		effect: "hidden",
 		description: "构建工具和系统修改"
 	},
 	{
 		type: "ci",
 		section: "🤖 CI",
+		effect: "hidden",
 		description: "持续集成配置"
 	},
-	{
-		type: "config",
-		section: "⚙️ 配置",
-		description: "配置文件更新"
-	},
 	{
 		type: "deps",
 		section: "📦 依赖更新",
+		effect: "changelog",
 		description: "依赖版本变更"
 	},
 	{
 		type: "security",
 		section: "🛡️ 安全修复",
+		effect: "changelog",
 		description: "安全性更新"
 	},
+	{
+		type: "hotfix",
+		section: "🚑 热修复",
+		effect: "changelog",
+		description: "紧急修复"
+	},
 	{
 		type: "i18n",
 		section: "🌐 国际化",
+		effect: "changelog",
 		description: "国际化相关更新"
 	},
 	{
 		type: "ux",
 		section: "🎨 用户体验",
+		effect: "changelog",
 		description: "用户体验改进"
 	},
 	{
-		type: "hotfix",
-		section: "🚑 热修复",
-		description: "紧急修复"
+		type: "config",
+		section: "⚙️ 配置",
+		effect: "hidden",
+		description: "配置文件更新"
 	},
 	{
 		type: "tool",
 		section: "🛠️ 工具链",
+		effect: "hidden",
 		description: "工具链变更"
 	}
 ];
 //#endregion
+//#region src/git/templates.ts
+const isLikelyHash = (value) => /^[0-9a-f]{7,40}$/i.test(value);
+function headerPartial(context) {
+	const { isPatch, linkCompare, version, title, date, previousTag } = context;
+	const fullTitle = words(linkCompare && !isLikelyHash(previousTag) ? link(version, compareUrl(context)) : version, title && `"${title}"`, date && `(${date})`);
+	return heading(2, isPatch ? small(fullTitle) : fullTitle);
+}
+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) => {
+		return each([words(note.commit.scope && bold(`${note.commit.scope}:`), commitPartial(context, note.commit)), note.commit.subject.trim() !== note.text.trim() ? list([note.text], (t) => t) : ""], (t) => t, newline());
+	})), newline(2)), each(commitGroups, (group) => segments(group.title && heading(3, group.title), list(group.commits, (commit) => commitPartial(context, commit))), newline(2)), footerPartial(context));
+}
+//#endregion
 //#region src/git/changelog.ts
-const parsePreset = async () => {
-	const preset = await createPreset({ types: defaultTypes.map((t) => ({
-		...t,
-		hidden: false
-	})) });
+const parsePreset = (options = {}) => {
+	const { includeHidden, transformTypes } = options;
+	let types = [...defaultTypes];
+	if (includeHidden) types.forEach((type) => {
+		if (type.effect === "hidden") type.effect = "changelog";
+	});
+	types = transformTypes?.(types) ?? types;
+	const preset = createPreset({ types });
 	preset.writer ??= {};
-	preset.writer.headerPartial = `## {{#if isPatch~}} <small> {{~/if~}}
-{{#if @root.linkCompare~}}
-[{{version}}](
-{{~#if @root.repository~}}
-  {{~#if @root.host}}
-    {{~@root.host}}/
-  {{~/if}}
-  {{~#if @root.owner}}
-    {{~@root.owner}}/
-  {{~/if}}
-  {{~@root.repository}}
-{{~else}}
-  {{~@root.repoUrl}}
-{{~/if~}}
-/compare/{{previousTag}}...{{currentTag}})
-{{~else}}
-{{~version}}
-{{~/if}}
-{{~#if title}} "{{title}}"
-{{~/if}}
-{{~#if date}} ({{date}})
-{{~/if}}
-{{~#if isPatch~}} </small> {{~/if}}
-`.trim() + eol();
-	preset.writer.mainTemplate = `{{> header}}
-{{#if noteGroups}}
-{{#each noteGroups}}
-
-### ⚠ {{title}}
-
-{{#each notes}}
-* {{#if commit.scope}}**{{commit.scope}}:** {{/if}}{{commit.subject}} {{#if commit.hash}}([{{commit.shortHash}}](https://github.com/{{@root.owner}}/{{@root.repository}}/commit/{{commit.hash}})){{/if}}
-{{/each}}
-{{/each}}
-{{/if}}
-{{#each commitGroups}}
-
-{{#if title}}
-### {{title}}
-
-{{/if}}
-{{#each commits}}
-{{> commit root=@root}}
-{{/each}}
-{{/each}}`.trim();
+	preset.writer.headerPartial = headerPartial;
+	preset.writer.template = template;
 	return preset;
 };
-const createGenerator = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
+const createGenerator = async (options) => {
+	const { getPkgDir, tagPrefix, releaseCount = 1, includeHidden, transformTypes } = options;
 	const pkgDir = getPkgDir();
-	const preset = await parsePreset();
-	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(preset).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
+	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(parsePreset({
+		includeHidden,
+		transformTypes
+	})).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
 };
-const getChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
-	const generator = await createGenerator({
-		getPkgDir,
-		tagPrefix,
-		releaseCount
-	});
+const getChangelog = async (options) => {
+	const generator = await createGenerator(options);
 	let changelog = "";
 	for await (const chunk of generator.write()) changelog += chunk;
 	return changelog.trimEnd();
 };
-const generateChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
+const generateChangelog = async (options) => {
+	const { getPkgDir, releaseCount = 1 } = options;
 	const infile = join(getPkgDir(), "CHANGELOG.md");
 	if (!existsSync(infile)) await writeFile(infile, "");
 	const exist = readFileSync(infile, "utf-8");
 	const writeStream = createWriteStream(infile);
-	const generator = await createGenerator({
-		getPkgDir,
-		tagPrefix,
-		releaseCount
-	});
+	const generator = await createGenerator(options);
 	for await (const chunk of generator.write()) writeStream.write(chunk);
 	const override = isZero(releaseCount);
 	if (!(isZero(exist.trim().length) || override)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/release",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Release project tool.",
   "license": "MIT",
   "type": "module",
@@ -34,9 +34,10 @@
     "@peiyanlu/ts-utils": "^0.0.8",
     "ansis": "^4.3.1",
     "commander": "^15.0.0",
-    "conventional-changelog": "^7.2.1",
-    "conventional-changelog-conventionalcommits": "^9.3.1",
-    "conventional-changelog-writer": "^8.3.0",
+    "conventional-changelog": "^8.0.0",
+    "conventional-changelog-conventionalcommits": "^10.2.0",
+    "conventional-recommended-bump": "^12.0.0",
+    "@conventional-changelog/template": "^1.2.0",
     "mime-types": "^3.0.2",
     "open": "^11.0.0",
     "publint": "^0.3.21",