@peiyanlu/release 0.0.16 → 1.0.0

package/dist/cli.mjs

@@ -1,11 +1,11 @@
 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, 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 { 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 { 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 { castArray, isFunction, isPlainObject, isUndefined, isZero, mapObjectValues } from "@peiyanlu/ts-utils";
 import { publint } from "publint";
 import { formatMessage } from "publint/utils";
 import { inc, neq } from "semver";
@@ -129,7 +129,7 @@ const MSG = {
 		GIT_PUSH: "Push commits and tags to remote?"
 	},
 	ERROR: {
-		GIT_WORKDIR: `[git] Working dir must be clean`,
+		GIT_WORKDIR: `[git] Working tree 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 for tag "${tag}" already exists and is not a draft`,
@@ -155,8 +155,8 @@ const MSG = {
 //#region src/git/commit.ts
 const gitCheck = async (ctx, config) => {
 	const { pkg: { name } } = ctx;
-	const { git: { requireRepository, requireRemote, requireWorkDirClean }, ignoreGit, ignoreGithub } = config;
-	if (ignoreGit) {
+	const { git: { requireRepository, requireRemote, requireCleanWorkingTree }, skipGit, skipGithub } = config;
+	if (skipGit) {
 		ctx.noGit = true;
 		ctx.noGitHub = true;
 		return;
@@ -167,8 +167,8 @@ const gitCheck = async (ctx, config) => {
 		ctx.noGitHub = true;
 		return;
 	}
-	if (requireWorkDirClean && !await isWorkingTreeClean()) throw new Error(MSG.ERROR.GIT_WORKDIR);
-	if (ignoreGithub) {
+	if (requireCleanWorkingTree && !await isWorkingTreeClean()) throw new Error(MSG.ERROR.GIT_WORKDIR);
+	if (skipGithub) {
 		ctx.noGitHub = true;
 		return;
 	}
@@ -438,9 +438,9 @@ const createDefaultConfig = (isCI) => {
 			},
 			releaseCount: 1
 		},
-		ignoreGit: false,
-		ignoreNpm: false,
-		ignoreGithub: false,
+		skipGit: false,
+		skipNpm: false,
+		skipGithub: false,
 		git: {
 			commit: isCI,
 			tag: isCI,
@@ -453,7 +453,7 @@ const createDefaultConfig = (isCI) => {
 			addUntrackedFiles: false,
 			requireRemote: true,
 			requireRepository: true,
-			requireWorkDirClean: true
+			requireCleanWorkingTree: true
 		},
 		npm: {
 			publish: isCI,
@@ -980,16 +980,26 @@ var Action = class {
 	}
 	async createContext(cmdArgs, options, prepare = false) {
 		const { version: cVersion, name: cName } = readJsonFile(join(__dirname, "../package.json"));
-		const { otp, package: defPkg, ...others } = options;
-		const { showChangelog, showRelease, ci, dryRun } = Object.fromEntries(Object.entries(others).map(([k, v]) => [k, Boolean(v)]));
+		const { otp, package: defPkg, releaseCount, ...others } = options;
+		const { showChangelog, showRelease, ci, dryRun } = 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 count = Number(releaseCount);
+			config.changelog.releaseCount = isNaN(count) ? 0 : count;
+			config.git.requireCleanWorkingTree = requireCleanWorkingTree;
+			config.skipGit = skipGit;
+			config.skipNpm = skipNpm;
+			config.skipGithub = skipGithub;
+			config.isMonorepo = isMonorepo;
+		}
 		console.log();
 		intro(prepare ? MSG.INTRO_PREPARE(dryRun) : MSG.INTRO(dryRun));
-		const { isMonorepo, packages, getPkgDir, ignoreNpm } = config;
+		const { isMonorepo, packages, getPkgDir, skipNpm } = config;
 		if (isMonorepo) {
 			if (ci) {
 				if (!defPkg) abortTask(MSG.ABORT.MONOREPO_CI_NO_PACKAGE);
@@ -1035,7 +1045,7 @@ var Action = class {
 				toPreRelease: false,
 				publishConfig: { ...publishConfig }
 			},
-			noNpm: pkgPrivate || ignoreNpm
+			noNpm: pkgPrivate || skipNpm
 		});
 		const { messages } = await publint({ pkgDir });
 		for (const message of messages) {
@@ -1210,13 +1220,13 @@ 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 (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).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("-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) => {
 	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).action((options) => {
-	const { force = false, monorepo = false } = 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) => {
+	const { force = false, monorepo = false, add = false } = options;
 	const cwd = process.cwd();
 	const { type } = readJsonFile(join(cwd, "package.json"));
 	const isESM = type === "module";
@@ -1236,9 +1246,13 @@ program.command("init").description("Create a release configuration file").optio
     tagPrefix: (pkg) => \`\${ pkg }@\`,
   },
 }`;
-	writeFileSync(configFile, [`import { defineConfig } from '@peiyanlu/release'`, `export default defineConfig(${monorepo ? monoConfigToString() : "{}"})`].join(eol(2)), "utf-8");
-	console.log(`${green`✔`} ${infile} created successfully`);
+	const content = [`import { defineConfig } from '@peiyanlu/release'`, `export default defineConfig(${monorepo ? monoConfigToString() : "{}"})`].join(eol(2));
+	writeFileSync(configFile, content, "utf-8");
+	console.log(`Wrote to ${underline(dim(configFile))}`);
+	if (add) gitAddSync([infile]);
+	console.log(`\n${content}`);
 });
+program.addHelpText("afterAll", "\nThanks for using!");
 program.parse(process.argv);
 program.on("command:*", () => {
 	console.error(`\n${red`Error`} Invalid command: ${red`%s`}`, program.args.join(" "));

package/dist/index.d.mts

@@ -28,15 +28,21 @@ interface ReleaseConfig {
    * 影响生成的日志数量、日志标题（monorepo）。
    */
   changelog: {
-    /** 作为 CHANGELOG 标题的 Tag 前缀，多包场景下需要 `${pkg}@` */tagPrefix: ((pkg: string) => string); /** 生成多少个版本的变更日志，详见 {@link Options} */
+    /**
+     * 作为 CHANGELOG 标题的 Tag 前缀，多包场景下需要 `${pkg}@`
+     */
+    tagPrefix: ((pkg: string) => string);
+    /**
+     * 生成多少个版本的变更日志，详见 {@link Options}
+     */
     releaseCount: number;
   };
-  /** 忽略 git、github 环境检查以及后续操作  */
-  ignoreGit: boolean;
-  /** 忽略 npm 环境检查以及后续操作 */
-  ignoreNpm: boolean;
-  /** 忽略 github 环境检查以及后续操作 */
-  ignoreGithub: boolean;
+  /** 跳过 git、github 环境检查以及后续操作  */
+  skipGit: boolean;
+  /** 跳过 npm 环境检查以及后续操作 */
+  skipNpm: boolean;
+  /** 跳过 github 环境检查以及后续操作 */
+  skipGithub: boolean;
   /**
    * Git 相关配置
    * 影响提交、打 tag、推送等本地/远程 Git 行为。
@@ -90,7 +96,7 @@ interface ReleaseConfig {
     /**
      * 是否要求工作目录保持干净（无未提交的更改）
      */
-    requireWorkDirClean: boolean;
+    requireCleanWorkingTree: boolean;
   };
   /**
    * NPM 发布相关配置

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/release",
-  "version": "0.0.16",
+  "version": "1.0.0",
   "description": "Release project tool.",
   "license": "MIT",
   "type": "module",
@@ -31,7 +31,7 @@
     "@clack/prompts": "^1.5.0",
     "@octokit/rest": "^22.0.1",
     "@peiyanlu/cli-utils": "^0.0.12",
-    "@peiyanlu/ts-utils": "^0.0.7",
+    "@peiyanlu/ts-utils": "^0.0.8",
     "ansis": "^4.3.1",
     "commander": "^15.0.0",
     "conventional-changelog": "^7.2.1",