@peiyanlu/release 1.1.2 → 1.2.1

package/README.md

@@ -1,19 +1,15 @@
 # Release Project
 
-<p>
-  <a href="https://www.npmjs.com/package/@peiyanlu/release" target="_blank">
-    <img src="https://img.shields.io/badge/npm-@peiyanlu/release-blue.svg?logo=npm" alt="NPM Package" />
-  </a>
-  <a href="https://www.npmjs.com/package/@peiyanlu/release" target="_blank">
-    <img src="https://img.shields.io/npm/v/@peiyanlu/release.svg" alt="NPM Version" />
-  </a>
-  <a href="https://www.npmjs.com/package/@peiyanlu/release" target="_blank">
-    <img src="https://img.shields.io/npm/l/@peiyanlu/release.svg" alt="Package License" />
-  </a>
-  <a href="https://www.npmjs.com/package/@peiyanlu/release" target="_blank">
-    <img src="https://img.shields.io/npm/dm/@peiyanlu/release.svg" alt="NPM Downloads" />
-  </a>
-</p>
+
+[![module](https://img.shields.io/badge/package-ESM--only-FFE536.svg?logo=npm)](https://nodejs.org/api/esm.html)
+[![npm](https://img.shields.io/npm/v/@peiyanlu/release.svg)](https://npmjs.com/package/@peiyanlu/release)
+[![license](https://img.shields.io/npm/l/@peiyanlu/release.svg)](https://npmjs.com/package/@peiyanlu/release)
+[![downloads](https://img.shields.io/npm/dm/@peiyanlu/release.svg)](https://npmjs.com/package/@peiyanlu/release)
+[![node](https://img.shields.io/node/v/@peiyanlu/release.svg)](https://nodejs.org)
+[![size](https://packagephobia.com/badge?p=@peiyanlu/release)](https://packagephobia.com/result?p=@peiyanlu/release)
+[![deps](https://img.shields.io/librariesio/release/npm/@peiyanlu/release)](https://libraries.io/npm/%40peiyanlu%2Frelease)
+[![build](https://img.shields.io/github/actions/workflow/status/peiyanlu/release/test.yaml?branch=master&logo=github)](https://github.com/peiyanlu/release/actions)
+[![coverage](https://coveralls.io/repos/github/peiyanlu/release/badge.svg?branch=master)](https://coveralls.io/github/peiyanlu/release?branch=master)
 
 🚀 **一个用于自动化版本管理与包发布的通用 CLI 工具**
 
@@ -282,6 +278,23 @@ COMMIT_TYPES：
 
 适用于 CI/CD 场景下的**安全、无 Token** 自动化发布。
 
+支持配置发布前清理：
+
+- 移除 `package.json` 中对发布无意义的字段
+- `README.md` 只保留主要内容
+
+```ts
+// 默认配置
+export default defineConfig({
+  npm: {
+    cleanup: {
+      packageJson: true,
+      readme: false,
+      removeTempDir: true,
+    }
+  },
+})
+```
 
 ## GitHub Releases
 
@@ -320,10 +333,13 @@ GitHub Release 可基于 Git Tag 自动创建，并支持附带：
 ### 示例用法
 
 - 发布到 npm
+
 ```ts
 // publishCI.ts
 
 import { publishTagToNpm } from '@peiyanlu/release'
+
+
 await publishTagToNpm({})
 ```
 
@@ -353,6 +369,7 @@ jobs:
 ```
 
 - 创建 GitHub Release
+
 ```yaml
 # .github/workflows/release.yml
 

package/dist/cli.mjs

@@ -1,29 +1,30 @@
-import path, { join, resolve } from "node:path";
-import { fileURLToPath, pathToFileURL } from "node:url";
-import { bumpPackageVersion, canPublish, 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, readJsonFile, resolveChangelogRange, resolvePublishTag } from "@peiyanlu/cli-utils";
+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 { 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 { cancel, confirm, group, intro, isCancel, log, outro, select, tasks, text } from "@clack/prompts";
-import { castArray, isFunction, isPlainObject, isUndefined, isZero, mapObject } from "@peiyanlu/ts-utils";
+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";
+import { pathToFileURL } from "node:url";
 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";
 import { glob } from "tinyglobby";
-//#region node_modules/.pnpm/tsdown@0.22.3_publint@0.3.21_typescript@6.0.3/node_modules/tsdown/esm-shims.js
-const getFilename = () => fileURLToPath(import.meta.url);
-const getDirname = () => path.dirname(getFilename());
-const __dirname = /* @__PURE__ */ getDirname();
+//#region package.json
+var name = "@peiyanlu/release";
+var version = "1.2.0";
+var description = "Release project tool.";
 //#endregion
 //#region src/config.ts
 const findConfigFile = (cwd = process.cwd()) => {
@@ -133,7 +134,7 @@ const MSG = {
 	},
 	ERROR: {
 		GIT_WORKDIR: `[git] Working tree must be clean`,
-		GIT_REGISTRY: (name) => `[git] Repository not found for ${dim(name)}`,
+		GIT_REGISTRY: (name) => `[git] Repository not found for package "${dim(name)}"`,
 		GIT_REMOTE: (name) => `[git] Remote "${dim(name)}" not found`,
 		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")}`,
@@ -141,7 +142,6 @@ const MSG = {
 		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_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: {
@@ -175,8 +175,9 @@ const gitCheck = async (ctx, config) => {
 		ctx.noGitHub = true;
 		return;
 	}
-	const { name: remoteName, url: remoteUrl } = (await getRemoteList())[0];
-	if (!remoteUrl) if (requireRemote) throw new Error(MSG.ERROR.GIT_REMOTE(name));
+	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;
@@ -186,9 +187,11 @@ const gitCheck = async (ctx, config) => {
 		remoteUrl
 	});
 	const [owner, repo] = parseGitHubRepo(remoteUrl);
+	const url = getGithubUrl(owner, repo);
 	Object.assign(ctx.github, {
 		owner,
-		repo
+		repo,
+		url
 	});
 };
 const commitAndTag = async (ctx, config) => {
@@ -401,6 +404,7 @@ const createDefaultContext = () => {
 			tagMessage: ""
 		},
 		github: {
+			url: "",
 			username: "",
 			repo: "",
 			changelog: "",
@@ -464,7 +468,12 @@ const createDefaultConfig = (isCI) => {
 		npm: {
 			publish: isCI,
 			publishArgs: [],
-			skipChecks: false
+			skipChecks: false,
+			cleanup: {
+				packageJson: true,
+				readme: false,
+				removeTempDir: true
+			}
 		},
 		github: {
 			release: isCI,
@@ -922,21 +931,138 @@ const runNpmOptPrompts = async (ctx, config) => {
 	return res;
 };
 //#endregion
+//#region src/npm/cleanup.ts
+const PUBLISH_CONFIG_FIELDS = [
+	"bin",
+	"main",
+	"exports",
+	"types",
+	"typings",
+	"module",
+	"browser",
+	"esnext",
+	"es2015",
+	"unpkg",
+	"umd:main",
+	"typesVersions",
+	"cpu",
+	"os",
+	"engines"
+];
+const IGNORE_FIELDS = [
+	"babel",
+	"browserslist",
+	"c8",
+	"commitlint",
+	"devDependencies",
+	"eslintConfig",
+	"eslintIgnore",
+	"husky",
+	"jest",
+	"lint-staged",
+	"nano-staged",
+	"pre-commit",
+	"prettier",
+	"pwmetrics",
+	"remarkConfig",
+	"renovate",
+	"resolutions",
+	"sharec",
+	"simple-git-hooks",
+	"simple-pre-commit",
+	"size-limit",
+	"typeCoverage",
+	"yaspeller",
+	"pnpm",
+	"packageManager"
+];
+const KEEP_SCRIPT_NAMES = [
+	"preinstall",
+	"install",
+	"postinstall"
+];
+const IGNORE_FILES = [
+	".DS_Store",
+	".git",
+	".vscode",
+	".idea",
+	"node_modules"
+];
+const clearPackageJSON = async (dir, options) => {
+	const file = join(dir, "package.json");
+	const json = await readJsonFile(file);
+	const { ignoreFields = [], keepScripts = [] } = options ?? {};
+	const mergePublishConfig = (json) => {
+		if (!json.publishConfig) return json;
+		const publishConfig = { ...json.publishConfig };
+		PUBLISH_CONFIG_FIELDS.forEach((field) => {
+			if (publishConfig[field]) {
+				json[field] = publishConfig[field];
+				delete publishConfig[field];
+			}
+		});
+		return {
+			...json,
+			publishConfig
+		};
+	};
+	const removeIgnoredFields = (json) => {
+		const [matched, unmatched] = partition([...ignoreFields, ...IGNORE_FIELDS], (i) => i.includes("."));
+		matched.forEach((field) => unset(json, field));
+		return omit(json, unmatched);
+	};
+	const cleanScripts = (json) => {
+		if (!json.scripts) return json;
+		const keep = [...keepScripts, ...KEEP_SCRIPT_NAMES];
+		const excludes = Object.keys(json.scripts).filter((k) => !keep.includes(k));
+		json.scripts = omit(json.scripts, excludes);
+		return json;
+	};
+	const removeEmptyObjects = (json) => {
+		return omit(json, Object.entries(json).filter(([k, v]) => isEmptyObject(v)).map(([k, v]) => k));
+	};
+	await writeJsonFile(file, removeEmptyObjects(cleanScripts(removeIgnoredFields(structuredClone(mergePublishConfig(json))))));
+};
+const cleanReadme = async (dir, homepage) => {
+	const file = join(dir, "README.md");
+	homepage && await editFile(file, (str) => {
+		return str.split(/^##\s+\S.*$/m)[0] + `## Docs
+
+Read full docs **[here](${homepage})**.`;
+	});
+};
+//#endregion
 //#region src/npm/publish.ts
+const canPublish = async (registry, cwd) => {
+	const res = await runNpm([
+		"publish",
+		"--dry-run",
+		"--access",
+		"public",
+		...registryArg(registry)
+	], {
+		error: "throw",
+		cwd
+	}).catch((err) => err);
+	const allowedErr = (err) => {
+		return [/previously published versions/i, /cannot publish over/i].some((reg) => reg.test(err.message));
+	};
+	if (!(res instanceof Error) || allowedErr(res)) return true;
+	throw res;
+};
 const npmCheck = async (ctx, config) => {
-	const { pkg: { name, current, publishConfig: { registry } } } = ctx;
-	const { npm: { skipChecks } } = config;
+	const { pkg: { name, current, publishConfig: { registry } }, selectedPkg } = ctx;
+	const { npm: { skipChecks }, getPkgDir } = config;
 	const tag = await resolvePublishTag(name, current);
 	Object.assign(ctx.npm, { tag });
 	if (skipChecks) return "";
-	const [pinged, username, canPublished] = await Promise.all([
+	const [pinged, username] = await Promise.all([
 		pingRegistry(registry),
 		getAuthenticatedUser(registry),
-		canPublish(registry)
+		canPublish(registry, getPkgDir(selectedPkg))
 	]);
 	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) {
@@ -945,18 +1071,34 @@ const npmCheck = async (ctx, config) => {
 	return latest ? `(${tag} → ${latest})` : `(${tag} → no published version)`;
 };
 const publishNpm = async (ctx, config) => {
-	const { dryRun, selectedPkg, npm: { otp, tag } } = ctx;
-	const { npm: { publish, publishArgs }, getPkgDir } = config;
+	const { dryRun, selectedPkg, npm: { otp, tag }, github: { url } } = ctx;
+	const { npm: { publish, publishArgs, cleanup: { packageJson, readme, removeTempDir } }, getPkgDir } = config;
 	if (!publish) return;
 	const otpArgs = otp ? ["--otp", otp] : [];
 	const dryRunArg = dryRun ? ["--dry-run"] : [];
-	return publishPackage({
+	const args = [
+		...otpArgs,
+		...publishArgs,
+		...dryRunArg
+	];
+	if (packageJson || readme) {
+		const parent = resolve(getPkgDir(selectedPkg));
+		const temp = await createTempDir(parent);
+		await copyDir(parent, temp.path, { ignore: [(name) => {
+			return [temp.name, ...IGNORE_FILES].map((pattern) => createMatcher(pattern)).some((matcher) => matcher(name));
+		}] });
+		const options = typeof packageJson === "boolean" ? void 0 : packageJson;
+		packageJson && await clearPackageJSON(temp.path, options);
+		readme && await cleanReadme(temp.path, `${url}#readme`);
+		await publishPackage({
+			tag,
+			args,
+			cwd: temp.path
+		});
+		removeTempDir && await temp.remove();
+	} else await publishPackage({
 		tag,
-		args: [
-			...otpArgs,
-			...publishArgs,
-			...dryRunArg
-		],
+		args,
 		cwd: getPkgDir(selectedPkg)
 	});
 };
@@ -975,7 +1117,7 @@ var Action = class {
 		taskEnd(MSG.OUTRO(ctx.dryRun));
 	}
 	async handlePrepareRelease(cmdArgs, options) {
-		const { ctx, config } = await this.createContext(cmdArgs, options, true);
+		const { ctx, config } = await this.createContext(cmdArgs, options);
 		await this.checkTask(ctx, config);
 		await this.bumpTask(ctx, config);
 		await this.changelogTask(ctx, config);
@@ -983,27 +1125,12 @@ var Action = class {
 		if (ctx.dryRun) gitRollback(ctx);
 		taskEnd(MSG.OUTRO_PREPARE(ctx.dryRun));
 	}
-	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, onlyChangelog } = mapObject(others, (k, v) => [k, 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));
+	async createContext(cmdArgs, options) {
+		const { configFile, config } = await this.createConfig(options);
+		info(MSG.INFO.TOOL(name, version));
 		info(MSG.INFO.CONFIG(configFile));
-		{
-			const { requireCleanWorkingTree, skipGit, skipNpm, skipGithub, isMonorepo, includeHidden } = mapObject(others, (k, v) => [k, 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;
-			config.skipGithub = skipGithub;
-			config.isMonorepo = isMonorepo;
-		}
 		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;
 		if (isMonorepo) {
@@ -1028,7 +1155,7 @@ var Action = class {
 		const nextVersion = inc(pkgVersion, cmdArgs) ?? "";
 		const ctx = mergeConfig(createDefaultContext(), {
 			selectedPkg,
-			configFileExists: Object.keys(local).length > 0,
+			configFileExists: isNotEmpty(configFile),
 			dryRun,
 			showRelease,
 			showChangelog,
@@ -1042,7 +1169,7 @@ var Action = class {
 				showRelease,
 				process.env.GITHUB_ACTIONS,
 				process.env.CI
-			].some((k) => Boolean(k)),
+			].some(Boolean),
 			pkg: {
 				name: pkgName,
 				isPrivate: pkgPrivate,
@@ -1064,6 +1191,34 @@ var Action = class {
 			config
 		};
 	}
+	async createConfig(options) {
+		const { ci, requireCleanWorkingTree, skipGit, skipNpm, skipGithub, isMonorepo, includeHidden, releaseCount } = options;
+		const toFalse = (value) => {
+			return isBoolean(value) && !value ? value : void 0;
+		};
+		const toNumber = (value) => {
+			return isNumber(value) ? value : void 0;
+		};
+		const defaultConfig = createDefaultConfig(ci ? true : void 0);
+		const { configFile, config: local } = await this.resolveUserConfig(process.cwd());
+		return {
+			configFile,
+			config: mergeConfig(mergeConfig(defaultConfig, local), {
+				changelog: {
+					releaseCount: toNumber(releaseCount),
+					includeHidden
+				},
+				git: { requireCleanWorkingTree: toFalse(requireCleanWorkingTree) },
+				skipGit,
+				skipNpm,
+				skipGithub,
+				isMonorepo
+			})
+		};
+	}
+	async resolveUserConfig(cwd = process.cwd()) {
+		return resolveConfig(cwd);
+	}
 	async printChangelog(ctx, config) {
 		const { showChangelog, selectedPkg, noGit, isIncrement } = ctx;
 		const { isMonorepo, getPkgDir, changelog: { tagPrefix, releaseCount, includeHidden, transformTypes } } = config;
@@ -1245,16 +1400,15 @@ 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("-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) => {
+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;
 	const action = new Action();
 	prepare ? await action.handlePrepareRelease(releaseType, options) : await action.handleRelease(releaseType, options);
 });
-program.command("init").description("Create a release configuration file").option("-f, --force", "Overwrite existing config file", false).option("-m, --monorepo", "Mono-repo project", false).option("-a, --add", "Automatically stage the config file.", false).action((options) => {
+program.command("init").description("Create a release configuration file").option("-f, --force", "Overwrite existing config file", false).option("-m, --monorepo", "Mono-repo project", false).option("-a, --add", "Automatically stage the config file.", false).action(async (options) => {
 	const { force = false, monorepo = false, add = false } = options;
 	const cwd = process.cwd();
-	const { type } = readJsonFile(join(cwd, "package.json"));
+	const { type } = readJsonFileSync(join(cwd, "package.json"));
 	const isESM = type === "module";
 	const isTS = existsSync(join(cwd, "tsconfig.json"));
 	const infile = `release.config.${isESM ? "" : "m"}${isTS ? "ts" : "js"}`;
@@ -1265,15 +1419,15 @@ program.command("init").description("Create a release configuration file").optio
 	}
 	const monoConfigToString = () => `{
   isMonorepo: true,
-  packages: [ 'demo-a', 'demo-b' ],
+  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(2));
-	writeFileSync(configFile, content, "utf-8");
+	const content = [`import { defineConfig } from '@peiyanlu/release'`, `export default defineConfig(${monorepo ? monoConfigToString() : "{}"})`].join(eol(3));
+	writeFileSync(configFile, content + newline(), "utf-8");
 	console.log(`Wrote to ${underline(dim(configFile))}`);
 	if (add) gitAddSync([infile]);
 	console.log(`\n${content}`);

package/dist/index.d.mts

@@ -1,22 +1,21 @@
-import { DeepPartial, DeepRequired } from "@peiyanlu/ts-utils";
+import { DeepPartial, DeepRequired, Simplify } from "@peiyanlu/ts-utils";
 import { ConventionalChangelog } from "conventional-changelog";
 import { CommitType as CommitType$1 } from "conventional-changelog-conventionalcommits";
 import { log } from "@clack/prompts";
-
 //#region src/types.d.ts
 interface CommitType {
   type: string;
   section?: string;
-  effect?: 'bump' | 'changelog' | 'hidden';
+  effect?: "bump" | "changelog" | "hidden";
   scope?: string;
   description?: string;
 }
 type Logger = typeof log;
-type HookTiming = 'before' | 'after';
-type HookAction = 'bump' | 'publish' | 'push' | 'release';
+type HookTiming = "before" | "after";
+type HookAction = "bump" | "publish" | "push" | "release";
 type ReleaseHookKey = `${HookTiming}:${HookAction}`;
 type ReleaseHookValue = string | string[] | ((logger: Logger) => Promise<void> | void);
-type HookConfig = { [key in ReleaseHookKey]: ReleaseHookValue };
+type HookConfig = { [key in ReleaseHookKey]: ReleaseHookValue; };
 interface ReleaseConfig {
   /**
    * 生命周期钩子配置
@@ -129,11 +128,42 @@ interface ReleaseConfig {
     publishArgs: string[];
     /**
      * 是否跳过发布前检查（如 ping、whoami 等校验）
+     *
+     * 启用后可减少发布前的网络请求，但可能无法提前发现登录状态异常或 Registry 不可用等问题。
      */
     skipChecks: boolean;
+    /**
+     * 发布前的文件清理配置
+     *
+     * 用于控制复制到临时发布目录后的清理行为，不会修改源项目文件。
+     */
+    cleanup: {
+      /**
+       * 是否清理 package.json
+       *
+       * 包括移除开发相关字段、应用 publishConfig，并保留发布所需内容。
+       */
+      packageJson: boolean | {
+        /** 需要忽略的字段，支持 `a.b.c` */
+        ignoreFields: string[];
+        /** 需要保留的脚本，默认：`preinstall | install | postinstall` */
+        keepScripts: string[];
+      };
+      /**
+       * 是否清理 README.md
+       *
+       * 仅保留主要内容，并移除或精简不需要随包发布的文档内容。
+       */
+      readme: boolean;
+      /**
+       * 是否在发布之后删除临时目录
+       */
+      removeTempDir: boolean;
+    };
   };
   /**
    * GitHub Release 相关配置
+   *
    * 控制是否创建 Release、发布方式以及上传资源。
    */
   github: {
@@ -201,9 +231,10 @@ interface ParsePresetOptions {
   /** 对默认 commit types 进行转换 */
   transformTypes?: (types: CommitType$1[]) => CommitType$1[];
 }
-declare const createGenerator: (options: GenerateOptions & ParsePresetOptions) => Promise<ConventionalChangelog>;
-declare const getChangelog: (options: GenerateOptions & ParsePresetOptions) => Promise<string>;
-declare const generateChangelog: (options: GenerateOptions & ParsePresetOptions) => Promise<void>;
+type GOptions = Simplify<GenerateOptions & ParsePresetOptions>;
+declare const createGenerator: (options: GOptions) => Promise<ConventionalChangelog>;
+declare const getChangelog: (options: GOptions) => Promise<string>;
+declare const generateChangelog: (options: GOptions) => Promise<void>;
 //#endregion
 //#region src/npm/publish.d.ts
 interface PublishTagOptions {

package/dist/index.mjs

@@ -8,6 +8,7 @@ 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 "@peiyanlu/node-utils";
 import { blue, cyan, green, magenta, red, underline, yellow } from "ansis";
 //#region src/config.ts
 function defineConfig(config) {
@@ -218,7 +219,6 @@ const publishTagToNpm = async (options) => {
 		[pkgName, version] = tag.split(tagSeparator);
 		console.log(`🔍 Parsed tag → package: "${yellow(pkgName)}", version: "${green(version)}"`);
 	} else {
-		pkgName = ".";
 		version = tag;
 		console.log(`🔍 Parsed tag → version only: "${green(version)}"`);
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/release",
-  "version": "1.1.2",
+  "version": "1.2.1",
   "description": "Release project tool.",
   "license": "MIT",
   "type": "module",
@@ -17,42 +17,27 @@
     },
     "./package.json": "./package.json"
   },
-  "scripts": {
-    "dev": "tsdown -w",
-    "build": "tsdown",
-    "prepublishOnly": "tsdown",
-    "release": "node index.js",
-    "test": "vitest run",
-    "test:cov": "vitest run --coverage"
-  },
   "dependencies": {
     "@actions/core": "^3.0.1",
     "@actions/github": "^9.1.1",
-    "@clack/prompts": "^1.5.0",
+    "@clack/prompts": "^1.7.0",
+    "@conventional-changelog/template": "^1.2.1",
     "@octokit/rest": "^22.0.1",
-    "@peiyanlu/cli-utils": "^0.0.13",
-    "@peiyanlu/ts-utils": "^0.0.9",
+    "@peiyanlu/cli-utils": "^0.0.15",
+    "@peiyanlu/node-utils": "^0.0.3",
+    "@peiyanlu/ts-utils": "^0.0.12",
     "ansis": "^4.3.1",
     "commander": "^15.0.0",
-    "conventional-changelog": "^8.0.0",
-    "conventional-changelog-conventionalcommits": "^10.2.0",
-    "conventional-recommended-bump": "^12.0.0",
-    "@conventional-changelog/template": "^1.2.0",
+    "conventional-changelog": "^8.1.0",
+    "conventional-changelog-conventionalcommits": "^10.2.1",
+    "conventional-recommended-bump": "^12.1.0",
     "mime-types": "^3.0.2",
+    "minimatch": "^10.2.5",
     "open": "^11.0.0",
-    "publint": "^0.3.21",
+    "publint": "^0.3.22",
     "semver": "^7.8.5",
     "tinyglobby": "^0.2.17"
   },
-  "devDependencies": {
-    "@types/mime-types": "^3.0.1",
-    "@types/node": "^24.12.4",
-    "@types/semver": "^7.7.1",
-    "@vitest/coverage-v8": "^4.1.8",
-    "tsdown": "^0.22.3",
-    "typescript": "^6.0.3",
-    "vitest": "^4.1.9"
-  },
   "author": {
     "name": "YanluPei",
     "email": "peiyanlu@vip.qq.com"