@peiyanlu/release 0.0.14 → 0.0.15

package/README.md

@@ -122,7 +122,9 @@ export default defineConfig({
   packages: [],
   getPkgDir: (pkg) => `.`,
   toTag: (pkg: string, version: string) => `v${ version }`,
-  tagPrefix: undefined,
+  changelog: {
+    tagPrefix: undefined,
+  },
   
   git: {
     commit: true,
@@ -157,7 +159,9 @@ export default defineConfig({
   packages: [ 'demo-a', 'demo-b' ],
   getPkgDir: (pkg) => `packages/${ pkg }`,
   toTag: (pkg: string, version: string) => `${ pkg }@${ version }`,
-  tagPrefix: (pkg: string) => `${ pkg }@`,
+  changelog: {
+    tagPrefix: (pkg: string) => `${ pkg }@`,
+  },
   
   git: {
     commit: true,

package/dist/cli.mjs

@@ -1,14 +1,14 @@
 import path, { join, resolve } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
-import { bumpPackageVersion, coloredChangeset, eol, execAsync, getAllRemotes, getAuthenticatedUser, getCurrentBranch, getGithubReleaseUrl, getGithubUrl, getLatestTag, getLog, getPackageInfo, getPackageUrl, getPublishedVersion, getRemote, getStatus, gitAddAll, gitAddTracked, gitCommit, gitTagAnnotated, hasWriteAccess, isGitRepo, isOtpError, isPrerelease, isValid, isWorkingDirClean, parseGitHubRepo, parseVersion, pingRegistry, publishPackage, pushBranch, pushTag, readJsonFile, resolveChangelogRange, resolvePublishTag } from "@peiyanlu/cli-utils";
+import { bumpPackageVersion, coloredChangeset, eol, execAsync, getAllRemotes, getAuthenticatedUser, getCurrentBranch, getGithubReleaseUrl, getGithubUrl, getLatestTag, getLog, getPackageInfo, getPackageUrl, getPublishedVersion, getRemote, getStatus, gitAddAll, gitAddTracked, gitCommit, gitTagAnnotated, hasWriteAccess, isGitRepo, isOtpError, isPrerelease, isValid, isWorkingDirClean, parseGitHubRepo, parseVersion, pingRegistry, publishPackage, pushBranch, pushTag, readJsonFile, registryArg, resolveChangelogRange, resolvePublishTag, runNpm } from "@peiyanlu/cli-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 { cancel, confirm, group, intro, isCancel, log, outro, select, tasks, text } from "@clack/prompts";
+import { castArray, isFunction, isPlainObject, isUndefined, isZero } from "@peiyanlu/ts-utils";
 import { publint } from "publint";
 import { formatMessage } from "publint/utils";
 import { inc, neq } from "semver";
-import { castArray, isFunction, isPlainObject, isUndefined } from "@peiyanlu/ts-utils";
 import { spawnSync } from "node:child_process";
 import { inspect } from "node:util";
 import { ConventionalChangelog } from "conventional-changelog";
@@ -54,13 +54,12 @@ const resolveConfig = async (cwd) => {
 	};
 };
 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) {
+	for (const key of Object.keys(defaults)) {
 		const defaultValue = defaults[key];
 		const overrideValue = overrides[key];
-		if (overrideValue === void 0) if (isFunction(defaultValue)) result[key] = defaultValue;
+		if (isUndefined(overrideValue)) if (isFunction(defaultValue)) result[key] = defaultValue;
+		else if (isPlainObject(defaultValue)) result[key] = mergeConfig(defaultValue, {});
 		else result[key] = structuredClone(defaultValue);
 		else if (isPlainObject(defaultValue) && isPlainObject(overrideValue)) result[key] = mergeConfig(defaultValue, overrideValue);
 		else if (isFunction(overrideValue)) result[key] = overrideValue;
@@ -134,13 +133,14 @@ const MSG = {
 		GIT_WORKDIR: `[git] Working dir must be clean`,
 		GIT_REGISTRY: (name) => `[git] Repository not found for ${dim(name)}`,
 		GIT_REMOTE: (name) => `[git] Remote "${dim(name)}" not found`,
-		GITHUB_TAG_EXIT: (tag) => `[github] Release or tag "${tag}" already exists`,
+		GITHUB_TAG_EXIT: (tag) => `[github] Release for tag "${tag}" already exists and is not a draft`,
 		GITHUB_TOKEN: (tokenRef) => `[github] Missing GitHub token. Please set ${yellow(tokenRef ?? "GITHUB_TOKEN")}`,
 		GITHUB_AUTH: "[github] Invalid GitHub token or insufficient permissions",
 		GITHUB_USER: "[github] User does not have permission to create releases",
 		NPM_REGISTRY: (registry) => `[npm] Unable to reach npm registry ${underline(dim(registry))}`,
-		NPM_AUTH: `[npm] Not authenticated with npm. Please run ${yellow("npm login")} and try again.`,
-		NPM_USER: (user, name) => `[npm] User ${dim(user)} is not a collaborator of ${dim(name)}.`
+		NPM_AUTH: `[npm] Not authenticated with npm. Please run ${yellow("npm login")} and try again`,
+		NPM_PERMISSION: `[npm] Missing publish permission. Please use a token with publish access and try again`,
+		NPM_USER: (user, name) => `[npm] User ${dim(user)} is not a collaborator of ${dim(name)}`
 	},
 	ABORT: {
 		CANCEL: "Operation cancelled",
@@ -444,8 +444,11 @@ const createDefaultConfig = (isCI) => {
 		toTag(pkg, version) {
 			return `v${version}`;
 		},
-		tagPrefix(pkg) {
-			return "";
+		changelog: {
+			tagPrefix(pkg) {
+				return "";
+			},
+			releaseCount: 1
 		},
 		ignoreGit: false,
 		ignoreNpm: false,
@@ -521,42 +524,42 @@ const defaultTypes = [
 	},
 	{
 		type: "chore",
-		section: "🎫 其他更新",
+		section: "🧹 其他更新",
 		description: "非功能性更改"
 	},
 	{
 		type: "refactor",
-		section: "♻ 代码重构",
+		section: "♻️ 代码重构",
 		description: "重构代码"
 	},
 	{
 		type: "test",
-		section: "✅ 测试",
+		section: "🧪 测试",
 		description: "测试更新"
 	},
 	{
 		type: "build",
-		section: "👷‍ 构建系统",
+		section: "🏗️ 构建系统",
 		description: "构建工具和系统修改"
 	},
 	{
 		type: "ci",
-		section: "🔧 CI 配置",
+		section: "🤖 CI",
 		description: "持续集成配置"
 	},
 	{
 		type: "config",
-		section: "🔨 配置",
+		section: "⚙️ 配置",
 		description: "配置文件更新"
 	},
 	{
 		type: "deps",
-		section: "🔗 依赖更新",
+		section: "📦 依赖更新",
 		description: "依赖版本变更"
 	},
 	{
 		type: "security",
-		section: "🔒 安全修复",
+		section: "🛡️ 安全修复",
 		description: "安全性更新"
 	},
 	{
@@ -566,13 +569,18 @@ const defaultTypes = [
 	},
 	{
 		type: "ux",
-		section: "🖥️ 用户体验",
+		section: "🎨 用户体验",
 		description: "用户体验改进"
 	},
 	{
 		type: "hotfix",
-		section: "🔥 热修复",
+		section: "🚑 热修复",
 		description: "紧急修复"
+	},
+	{
+		type: "tool",
+		section: "🛠️ 工具链",
+		description: "工具链变更"
 	}
 ];
 //#endregion
@@ -632,32 +640,37 @@ const parsePreset = async () => {
 {{/each}}`.trim();
 	return preset;
 };
-const createGenerator = async ({ getPkgDir, tagPrefix }) => {
+const createGenerator = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
 	const pkgDir = getPkgDir();
 	const preset = await parsePreset();
-	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(preset).options({ releaseCount: 1 }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
+	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(preset).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
 };
-const getChangelog = async ({ getPkgDir, tagPrefix }) => {
+const getChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
 	const generator = await createGenerator({
 		getPkgDir,
-		tagPrefix
+		tagPrefix,
+		releaseCount
 	});
 	let changelog = "";
 	for await (const chunk of generator.write()) changelog += chunk;
 	return changelog;
 };
-const generateChangelog = async ({ getPkgDir, tagPrefix }) => {
+const generateChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
 	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
+		tagPrefix,
+		releaseCount
 	});
-	const writeStream = createWriteStream(infile);
 	for await (const chunk of generator.write()) writeStream.write(chunk);
-	if (exist.trim().length) writeStream.write(eol(2));
-	writeStream.write(exist);
+	const override = isZero(releaseCount);
+	if (!(isZero(exist.trim().length) || override)) {
+		writeStream.write(eol());
+		writeStream.write(exist);
+	}
 	writeStream.end();
 	await finished(writeStream);
 };
@@ -776,7 +789,7 @@ const createCReleaseByTag = async (octokit, options) => {
 	const existing = await getReleaseByTagSafe(octokit, options);
 	if (!existing) return createCRelease(octokit, { ...options });
 	const { draft, id: releaseId } = existing;
-	if (!draft) throw new Error(`Release for tag "${options.tag}" already exists and is not a draft`);
+	if (!draft) throw new Error(MSG.ERROR.GITHUB_TAG_EXIT(options.tag));
 	return updateCRelease(octokit, {
 		releaseId,
 		...options
@@ -919,15 +932,32 @@ const runNpmOptPrompts = async (ctx, config) => {
 };
 //#endregion
 //#region src/npm/publish.ts
+const canPublish = async (registry) => {
+	const res = await runNpm([
+		"publish",
+		"--dry-run",
+		"--no-git-checks",
+		"--access",
+		"public",
+		...registryArg(registry)
+	], { error: "throw" }).catch((err) => err);
+	if (!(res instanceof Error)) return true;
+	return [/previously published versions/i, /cannot publish over/i].some((reg) => reg.test(res.message));
+};
 const npmCheck = async (ctx, config) => {
 	const { pkg: { name, current, publishConfig: { registry } } } = ctx;
 	const { npm: { skipChecks } } = config;
 	const tag = await resolvePublishTag(name, current);
 	Object.assign(ctx.npm, { tag });
 	if (skipChecks) return "";
-	const [pinged, username] = await Promise.all([pingRegistry(registry), getAuthenticatedUser(registry)]);
+	const [pinged, username, canPublished] = await Promise.all([
+		pingRegistry(registry),
+		getAuthenticatedUser(registry),
+		canPublish(registry)
+	]);
 	if (!pinged) throw new Error(MSG.ERROR.NPM_REGISTRY(registry));
 	if (!username) throw new Error(MSG.ERROR.NPM_AUTH);
+	if (!canPublished) throw new Error(MSG.ERROR.NPM_PERMISSION);
 	Object.assign(ctx.npm, { username });
 	const latest = await getPublishedVersion(`${name}@${tag}`);
 	if (latest) {
@@ -1077,7 +1107,7 @@ var Action = class {
 	}
 	async bumpTask(ctx, config) {
 		const { pkg: { current }, dryRun, isCI, showRelease, showChangelog, selectedPkg, noGit } = ctx;
-		const { isMonorepo, hooks, getPkgDir, tagPrefix } = config;
+		const { isMonorepo, hooks, getPkgDir, changelog: { tagPrefix, releaseCount } } = config;
 		const need = (ctx) => {
 			const { pkg: { next }, isIncrement } = ctx;
 			return !next && isIncrement;
@@ -1107,11 +1137,16 @@ var Action = class {
 		}]).catch((err) => abortOnError(err, ctx));
 		await runLifeCycleHook(hooks, "after:bump", dryRun);
 		if (noGit) return;
-		const { from, to } = await resolveChangelogRange(isIncrement, isMonorepo ? `${tagPrefix?.(selectedPkg)}*` : "*");
+		const match = isMonorepo ? `${tagPrefix?.(selectedPkg)}*` : "*";
+		const { from, to } = isZero(releaseCount) ? {
+			from: "",
+			to: "HEAD"
+		} : await resolveChangelogRange(isIncrement, match);
 		const commits = await getLog(from, to, getPkgDir(selectedPkg));
 		const changelog = await getChangelog({
 			getPkgDir: () => getPkgDir(selectedPkg),
-			tagPrefix: tagPrefix?.(selectedPkg)
+			tagPrefix: tagPrefix?.(selectedPkg),
+			releaseCount
 		});
 		Object.assign(ctx.github, { changelog });
 		if (commits) {
@@ -1122,14 +1157,15 @@ var Action = class {
 	}
 	async changelogTask(ctx, config) {
 		const { isIncrement, dryRun, selectedPkg, noGit } = ctx;
-		const { getPkgDir, tagPrefix } = config;
+		const { getPkgDir, changelog: { tagPrefix, releaseCount } } = config;
 		if (noGit) return;
 		await tasks([{
 			title: MSG.TASK.CHANGELOG.START,
 			task: async () => {
 				await generateChangelog({
 					getPkgDir: () => getPkgDir(selectedPkg),
-					tagPrefix: tagPrefix?.(selectedPkg)
+					tagPrefix: tagPrefix?.(selectedPkg),
+					releaseCount
 				});
 				await gitAddAll();
 				return success(MSG.TASK.CHANGELOG.END, dryRun);
@@ -1222,7 +1258,9 @@ program.command("init").description("Create a release configuration file").optio
   packages: [ 'demo-a', 'demo-b' ],
   getPkgDir: (pkg) => \`packages/\${ pkg }\`,
   toTag: (pkg, version) => \`\${ pkg }@\${ version }\`,
-  tagPrefix: (pkg) => \`\${ pkg }@\`,
+  changelog: {
+    tagPrefix: (pkg) => \`\${ pkg }@\`,
+  },
 }`;
 	writeFileSync(configPath, [`import { defineConfig } from '@peiyanlu/release'`, `export default defineConfig(${monorepo ? monoConfigToString() : "{}"})`].join(eol(2)), "utf-8");
 	console.log(`${green`✔`} ${infile} created successfully`);

package/dist/index.d.mts

@@ -23,14 +23,20 @@ interface ReleaseConfig {
   getPkgDir: (pkg: string) => string;
   /** 使用 monorepo 时使用 toTag，例如 `${pkg}@${version}`，默认为 `v${version}` 作为单仓库 */
   toTag: (pkg: string, version: string) => string;
-  /** 作为 CHANGELOG 标题的 Tag 前缀，多包场景下需要 `${pkg}@` */
-  tagPrefix: ((pkg: string) => string) | undefined;
+  /**
+   * CHANGELOG 相关配置
+   * 影响生成的日志数量、日志标题（monorepo）。
+   */
+  changelog: {
+    /** 作为 CHANGELOG 标题的 Tag 前缀，多包场景下需要 `${pkg}@` */tagPrefix: ((pkg: string) => string); /** 生成多少个版本的变更日志，详见 {@link Options} */
+    releaseCount: number;
+  };
   /** 忽略 git、github 环境检查以及后续操作  */
-  ignoreGit: boolean | undefined;
+  ignoreGit: boolean;
   /** 忽略 npm 环境检查以及后续操作 */
-  ignoreNpm: boolean | undefined;
+  ignoreNpm: boolean;
   /** 忽略 github 环境检查以及后续操作 */
-  ignoreGithub: boolean | undefined;
+  ignoreGithub: boolean;
   /**
    * Git 相关配置
    * 影响提交、打 tag、推送等本地/远程 Git 行为。
@@ -156,27 +162,32 @@ 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>;
+declare const mergeConfig: <T extends object>(defaults: DeepRequired<T>, overrides: DeepPartial<T>) => DeepRequired<T>;
 //#endregion
 //#region src/git/changelog.d.ts
-interface Options {
+interface GenerateOptions {
   /** @example () => `packages/${pkg}` */
   getPkgDir: () => string;
   /** @example `${pkg}@` */
   tagPrefix?: string;
+  /** 生成多少个变更日志，详见 {@link Options} */
+  releaseCount?: number;
 }
 declare const createGenerator: ({
   getPkgDir,
-  tagPrefix
-}: Options) => Promise<ConventionalChangelog>;
+  tagPrefix,
+  releaseCount
+}: GenerateOptions) => Promise<ConventionalChangelog>;
 declare const getChangelog: ({
   getPkgDir,
-  tagPrefix
-}: Options) => Promise<string>;
+  tagPrefix,
+  releaseCount
+}: GenerateOptions) => Promise<string>;
 declare const generateChangelog: ({
   getPkgDir,
-  tagPrefix
-}: Options) => Promise<void>;
+  tagPrefix,
+  releaseCount
+}: GenerateOptions) => Promise<void>;
 //#endregion
 //#region src/npm/publish.d.ts
 interface PublishTagOptions {

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { isFunction, isPlainObject } from "@peiyanlu/ts-utils";
+import { 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";
@@ -12,13 +12,12 @@ function defineConfig(config) {
 	return config;
 }
 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) {
+	for (const key of Object.keys(defaults)) {
 		const defaultValue = defaults[key];
 		const overrideValue = overrides[key];
-		if (overrideValue === void 0) if (isFunction(defaultValue)) result[key] = defaultValue;
+		if (isUndefined(overrideValue)) if (isFunction(defaultValue)) result[key] = defaultValue;
+		else if (isPlainObject(defaultValue)) result[key] = mergeConfig(defaultValue, {});
 		else result[key] = structuredClone(defaultValue);
 		else if (isPlainObject(defaultValue) && isPlainObject(overrideValue)) result[key] = mergeConfig(defaultValue, overrideValue);
 		else if (isFunction(overrideValue)) result[key] = overrideValue;
@@ -66,42 +65,42 @@ const defaultTypes = [
 	},
 	{
 		type: "chore",
-		section: "🎫 其他更新",
+		section: "🧹 其他更新",
 		description: "非功能性更改"
 	},
 	{
 		type: "refactor",
-		section: "♻ 代码重构",
+		section: "♻️ 代码重构",
 		description: "重构代码"
 	},
 	{
 		type: "test",
-		section: "✅ 测试",
+		section: "🧪 测试",
 		description: "测试更新"
 	},
 	{
 		type: "build",
-		section: "👷‍ 构建系统",
+		section: "🏗️ 构建系统",
 		description: "构建工具和系统修改"
 	},
 	{
 		type: "ci",
-		section: "🔧 CI 配置",
+		section: "🤖 CI",
 		description: "持续集成配置"
 	},
 	{
 		type: "config",
-		section: "🔨 配置",
+		section: "⚙️ 配置",
 		description: "配置文件更新"
 	},
 	{
 		type: "deps",
-		section: "🔗 依赖更新",
+		section: "📦 依赖更新",
 		description: "依赖版本变更"
 	},
 	{
 		type: "security",
-		section: "🔒 安全修复",
+		section: "🛡️ 安全修复",
 		description: "安全性更新"
 	},
 	{
@@ -111,13 +110,18 @@ const defaultTypes = [
 	},
 	{
 		type: "ux",
-		section: "🖥️ 用户体验",
+		section: "🎨 用户体验",
 		description: "用户体验改进"
 	},
 	{
 		type: "hotfix",
-		section: "🔥 热修复",
+		section: "🚑 热修复",
 		description: "紧急修复"
+	},
+	{
+		type: "tool",
+		section: "🛠️ 工具链",
+		description: "工具链变更"
 	}
 ];
 //#endregion
@@ -177,32 +181,37 @@ const parsePreset = async () => {
 {{/each}}`.trim();
 	return preset;
 };
-const createGenerator = async ({ getPkgDir, tagPrefix }) => {
+const createGenerator = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
 	const pkgDir = getPkgDir();
 	const preset = await parsePreset();
-	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(preset).options({ releaseCount: 1 }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
+	return new ConventionalChangelog().readPackage(`${pkgDir}/package.json`).config(preset).options({ releaseCount }).commits({ path: pkgDir }).tags({ prefix: tagPrefix });
 };
-const getChangelog = async ({ getPkgDir, tagPrefix }) => {
+const getChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
 	const generator = await createGenerator({
 		getPkgDir,
-		tagPrefix
+		tagPrefix,
+		releaseCount
 	});
 	let changelog = "";
 	for await (const chunk of generator.write()) changelog += chunk;
 	return changelog;
 };
-const generateChangelog = async ({ getPkgDir, tagPrefix }) => {
+const generateChangelog = async ({ getPkgDir, tagPrefix, releaseCount = 1 }) => {
 	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
+		tagPrefix,
+		releaseCount
 	});
-	const writeStream = createWriteStream(infile);
 	for await (const chunk of generator.write()) writeStream.write(chunk);
-	if (exist.trim().length) writeStream.write(eol(2));
-	writeStream.write(exist);
+	const override = isZero(releaseCount);
+	if (!(isZero(exist.trim().length) || override)) {
+		writeStream.write(eol());
+		writeStream.write(exist);
+	}
 	writeStream.end();
 	await finished(writeStream);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/release",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "Release project tool.",
   "license": "MIT",
   "type": "module",
@@ -20,7 +20,7 @@
   "scripts": {
     "dev": "tsdown -w",
     "build": "tsdown",
-    "prepublish": "tsdown",
+    "prepublishOnly": "tsdown",
     "release": "node index.js",
     "test": "vitest run",
     "test:cov": "vitest run --coverage"
@@ -30,8 +30,8 @@
     "@actions/github": "^9.1.1",
     "@clack/prompts": "^1.5.0",
     "@octokit/rest": "^22.0.1",
-    "@peiyanlu/cli-utils": "^0.0.8",
-    "@peiyanlu/ts-utils": "^0.0.5",
+    "@peiyanlu/cli-utils": "^0.0.9",
+    "@peiyanlu/ts-utils": "^0.0.7",
     "ansis": "^4.3.1",
     "commander": "^15.0.0",
     "conventional-changelog": "^7.2.0",