@peiyanlu/cli-utils 0.0.3 → 0.0.4

package/dist/cjs/index.cjs

@@ -135,26 +135,28 @@ const parseGitHubRepo = (url) => {
 const eol = (n = 1) => node_os.EOL.repeat(n);
 
 //#endregion
-//#region src/shell.ts
+//#region src/styleText.ts
 const dim = (text) => (0, node_util.styleText)(["dim"], text);
 const red = (text) => (0, node_util.styleText)(["red"], text);
-const yellow = (text) => (0, node_util.styleText)(["yellow"], text);
-const underline = (text) => (0, node_util.styleText)(["underline"], text);
+
+//#endregion
+//#region src/shell.ts
+/** 异步执行 `spawn` 获取字符串类型的结果 */
 const spawnAsync = (cmd, args, options) => {
-	return new Promise((resolve$1) => {
+	return new Promise((resolve$2) => {
 		const { trim, error, dryRun, ...others } = options ?? {};
-		const fullCmd = [cmd, ...args].join(" ");
+		const fullCmd = stringifyArgs([cmd, ...args]);
 		if (dryRun) {
 			console.log(`${dim("[dry-run]")} ${fullCmd}`);
-			return resolve$1(void 0);
+			return resolve$2(void 0);
 		}
 		const child = (0, node_child_process.spawn)(cmd, args, { ...others });
 		let stdout = "";
-		child.stdout?.setEncoding("utf-8");
+		child.stdout.setEncoding("utf-8");
 		child.stdout?.on("data", (data) => stdout += trim ? data.trim() : data);
 		let stderr = "";
-		child.stderr?.setEncoding("utf-8");
-		child.stderr?.on("data", (data) => stderr += trim ? data.trim() : data);
+		child.stderr.setEncoding("utf-8");
+		child.stderr.on("data", (data) => stderr += trim ? data.trim() : data);
 		child.on("close", (code) => {
 			if (stderr) {
 				const err = `${red("spawnAsync")} ${dim(fullCmd)} ${stderr}`;
@@ -165,38 +167,69 @@ const spawnAsync = (cmd, args, options) => {
 					case "throw": throw new Error(err);
 				}
 			}
-			resolve$1(0 === code ? stdout : void 0);
+			resolve$2(0 === code ? stdout : void 0);
 		});
 	});
 };
-const execAsync = (cmd, options) => {
-	return new Promise((resolve$1) => {
+/** 异步执行 `exec` 获取字符串类型的结果 */
+const execAsync = (cmd, argsOrOptions, maybeOptions) => {
+	return new Promise((resolve$2) => {
+		let command;
+		let options;
+		if (Array.isArray(argsOrOptions)) {
+			command = stringifyArgs([cmd, ...argsOrOptions]);
+			options = maybeOptions;
+		} else {
+			command = cmd;
+			options = argsOrOptions;
+		}
 		const { trim, dryRun, error, ...others } = options ?? {};
 		if (dryRun) {
-			console.log(`${dim("[dry-run]")} ${cmd}`);
-			return resolve$1(void 0);
+			console.log(`${dim("[dry-run]")} ${command}`);
+			return resolve$2(void 0);
 		}
-		(0, node_child_process.exec)(cmd, { ...others }, (err, stdout) => {
-			if (err) {
-				const msg = `${red("execAsync")} ${dim(cmd)} ${err.message}`;
+		(0, node_child_process.exec)(command, { ...others }, (stderr, stdout) => {
+			if (stderr) {
+				const err = `${red("execAsync")} ${dim(command)} ${stderr.message}`;
 				switch (error) {
 					case "log":
-						console.error(msg);
+						console.error(err);
 						break;
-					case "throw": throw new Error(msg);
+					case "throw": throw new Error(err);
 				}
 			}
-			resolve$1(err ? void 0 : trim ? stdout.trim() : stdout);
+			resolve$2(stderr ? void 0 : trim ? stdout.trim() : stdout);
 		});
 	});
 };
+/** 基于 {@link spawnAsync} 实现 */
 const runGit = async (args, options = { trim: true }) => {
 	return spawnAsync("git", args, options);
 };
+/** 基于 {@link execAsync} 实现 */
 const runNpm = (args, options = { trim: true }) => {
-	return execAsync(["npm", ...args].join(" "), options);
+	return execAsync("npm", args, options);
+};
+/** 基于 {@link spawnSync} 实现 */
+const runGitSync = (args, options) => {
+	const { stdout } = (0, node_child_process.spawnSync)("git", args, {
+		encoding: "utf-8",
+		...options
+	});
+	return stdout.toString().trim();
+};
+/** 基于 {@link execSync} 实现 */
+const runNpmSync = (args, options) => {
+	return (0, node_child_process.execSync)(stringifyArgs(["npm", ...args]), {
+		encoding: "utf-8",
+		...options
+	}).toString().trim();
 };
-const fixArgs = (args) => args.trim() ? args.trim().split(" ") : [];
+/** 将字符串以空格分割为数组 */
+const parseArgs = (args) => args.trim() ? args.trim().split(" ") : [];
+/** 将数组以空格拼接为字符串 */
+const stringifyArgs = (args) => args.length ? args.join(" ") : "";
+/** 支持所有支持 `--version` 命令的脚本查看版本 */
 const checkVersion = async (cmd) => {
 	return execAsync(`${cmd} --version`);
 };
@@ -234,14 +267,16 @@ function joinUrl(input) {
 
 //#endregion
 //#region src/git.ts
+/** 判断指定目录是否是 git 仓库 */
 const isGitRepo = async (dir) => {
-	return !!await runGit([
+	return "true" === await runGit([
 		"-C",
-		dir ? `./${dir}` : ".",
+		(0, node_path.resolve)(process.cwd(), dir || "."),
 		"rev-parse",
 		"--is-inside-work-tree"
 	]);
 };
+/** 获取指定的 git 配置 */
 const getGitConfig = (key, global = true) => {
 	return runGit([
 		"config",
@@ -249,6 +284,7 @@ const getGitConfig = (key, global = true) => {
 		key
 	]);
 };
+/** 获取 git 远程地址 */
 const getGitRemoteUrl = async (remoteName = "origin") => {
 	return runGit([
 		"remote",
@@ -263,6 +299,7 @@ const getGitRemoteUrl = async (remoteName = "origin") => {
 
 //#endregion
 //#region src/npm.ts
+/** 获取指定包的版本 */
 const pkgVersion = (pkg) => {
 	return runNpm([
 		"view",
@@ -278,13 +315,11 @@ exports.PkgManager = PkgManager;
 exports.YesOrNo = YesOrNo;
 exports.checkVersion = checkVersion;
 exports.copyDirAsync = copyDirAsync;
-exports.dim = dim;
 exports.editFile = editFile;
 exports.editJsonFile = editJsonFile;
 exports.emptyDir = emptyDir;
 exports.eol = eol;
 exports.execAsync = execAsync;
-exports.fixArgs = fixArgs;
 exports.getGitConfig = getGitConfig;
 exports.getGitRemoteUrl = getGitRemoteUrl;
 exports.isEmpty = isEmpty;
@@ -292,17 +327,18 @@ exports.isGitRepo = isGitRepo;
 exports.isTestFile = isTestFile;
 exports.isValidPackageName = isValidPackageName;
 exports.joinUrl = joinUrl;
+exports.parseArgs = parseArgs;
 exports.parseGitHubRepo = parseGitHubRepo;
 exports.pkgFromUserAgent = pkgFromUserAgent;
 exports.pkgVersion = pkgVersion;
 exports.readJsonFile = readJsonFile;
 exports.readSubDirs = readSubDirs;
-exports.red = red;
 exports.runCliForTest = runCliForTest;
 exports.runGit = runGit;
+exports.runGitSync = runGitSync;
 exports.runNpm = runNpm;
+exports.runNpmSync = runNpmSync;
 exports.spawnAsync = spawnAsync;
+exports.stringifyArgs = stringifyArgs;
 exports.toValidPackageName = toValidPackageName;
-exports.toValidProjectName = toValidProjectName;
-exports.underline = underline;
-exports.yellow = yellow;
+exports.toValidProjectName = toValidProjectName;

package/dist/cjs/index.d.cts

@@ -1,5 +1,6 @@
+import { ExecOptionsWithStringEncoding, SpawnOptionsWithoutStdio } from "node:child_process";
 import * as child_process0 from "child_process";
-import { ExecOptions, SpawnOptions, SpawnSyncOptionsWithStringEncoding } from "child_process";
+import { ExecSyncOptionsWithStringEncoding, SpawnSyncOptionsWithStringEncoding } from "child_process";
 
 //#region src/enums.d.ts
 declare enum PkgManager {
@@ -38,12 +39,15 @@ interface PkgInfo {
   version: string;
 }
 interface ExecResultOptions {
+  /** 去掉结果的首尾空格 */
   trim?: boolean;
+  /** 仅打印命令，不实际执行命令 */
   dryRun?: boolean;
+  /** log: 打印错误信息，返回 undefined; throw: 抛出错误; ignore: 返回 undefined */
   error?: 'log' | 'throw' | 'ignore';
 }
-type SpawnAsyncOptions<T = SpawnOptions> = T & ExecResultOptions;
-type ExecAsyncOptions<T = ExecOptions> = T & ExecResultOptions;
+type SpawnAsyncOptions = SpawnOptionsWithoutStdio & ExecResultOptions;
+type ExecAsyncOptions = ExecOptionsWithStringEncoding & ExecResultOptions;
 //#endregion
 //#region src/utils.d.ts
 declare const isValidPackageName: (packageName: string) => boolean;
@@ -68,15 +72,27 @@ declare const parseGitHubRepo: (url: string) => string[];
 declare const eol: (n?: number) => string;
 //#endregion
 //#region src/shell.d.ts
-declare const dim: (text: string) => string;
-declare const red: (text: string) => string;
-declare const yellow: (text: string) => string;
-declare const underline: (text: string) => string;
-declare const spawnAsync: <T = SpawnOptions>(cmd: string, args: string[], options?: SpawnAsyncOptions<T>) => Promise<string | undefined>;
-declare const execAsync: <T = ExecOptions>(cmd: string, options?: ExecAsyncOptions<T>) => Promise<string | undefined>;
+/** 异步执行 `spawn` 获取字符串类型的结果 */
+declare const spawnAsync: (cmd: string, args: string[], options?: SpawnAsyncOptions) => Promise<string | undefined>;
+type ExecAsync = {
+  (cmd: string, options?: ExecAsyncOptions): Promise<string | undefined>;
+  (cmd: string, args: string[], options?: ExecAsyncOptions): Promise<string | undefined>;
+};
+/** 异步执行 `exec` 获取字符串类型的结果 */
+declare const execAsync: ExecAsync;
+/** 基于 {@link spawnAsync} 实现 */
 declare const runGit: (args: string[], options?: SpawnAsyncOptions) => Promise<string | undefined>;
+/** 基于 {@link execAsync} 实现 */
 declare const runNpm: (args: string[], options?: ExecAsyncOptions) => Promise<string | undefined>;
-declare const fixArgs: (args: string) => string[];
+/** 基于 {@link spawnSync} 实现 */
+declare const runGitSync: (args: string[], options?: SpawnSyncOptionsWithStringEncoding) => string;
+/** 基于 {@link execSync} 实现 */
+declare const runNpmSync: (args: string[], options?: ExecSyncOptionsWithStringEncoding) => string;
+/** 将字符串以空格分割为数组 */
+declare const parseArgs: (args: string) => string[];
+/** 将数组以空格拼接为字符串 */
+declare const stringifyArgs: (args: string[]) => string;
+/** 支持所有支持 `--version` 命令的脚本查看版本 */
 declare const checkVersion: (cmd: string) => Promise<string | undefined>;
 //#endregion
 //#region src/joinUrl.d.ts
@@ -84,11 +100,15 @@ declare function joinUrl(...args: string[]): string;
 declare function joinUrl(input: readonly string[]): string;
 //#endregion
 //#region src/git.d.ts
+/** 判断指定目录是否是 git 仓库 */
 declare const isGitRepo: (dir?: string) => Promise<boolean>;
+/** 获取指定的 git 配置 */
 declare const getGitConfig: (key: string, global?: boolean) => Promise<string | undefined>;
+/** 获取 git 远程地址 */
 declare const getGitRemoteUrl: (remoteName?: string) => Promise<string | undefined>;
 //#endregion
 //#region src/npm.d.ts
+/** 获取指定包的版本 */
 declare const pkgVersion: (pkg: string) => Promise<string | undefined>;
 //#endregion
-export { CliOptions, ConfirmResult, CopyOptions, ExecAsyncOptions, ExecResultOptions, HttpLibrary, PkgInfo, PkgManager, SpawnAsyncOptions, YesOrNo, checkVersion, copyDirAsync, dim, editFile, editJsonFile, emptyDir, eol, execAsync, fixArgs, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, joinUrl, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, red, runCliForTest, runGit, runNpm, spawnAsync, toValidPackageName, toValidProjectName, underline, yellow };
+export { CliOptions, ConfirmResult, CopyOptions, ExecAsyncOptions, ExecResultOptions, HttpLibrary, PkgInfo, PkgManager, SpawnAsyncOptions, YesOrNo, checkVersion, copyDirAsync, editFile, editJsonFile, emptyDir, eol, execAsync, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, joinUrl, parseArgs, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, runCliForTest, runGit, runGitSync, runNpm, runNpmSync, spawnAsync, stringifyArgs, toValidPackageName, toValidProjectName };

package/dist/esm/index.d.mts

@@ -1,5 +1,6 @@
+import { ExecOptionsWithStringEncoding, SpawnOptionsWithoutStdio } from "node:child_process";
 import * as child_process0 from "child_process";
-import { ExecOptions, SpawnOptions, SpawnSyncOptionsWithStringEncoding } from "child_process";
+import { ExecSyncOptionsWithStringEncoding, SpawnSyncOptionsWithStringEncoding } from "child_process";
 
 //#region src/enums.d.ts
 declare enum PkgManager {
@@ -38,12 +39,15 @@ interface PkgInfo {
   version: string;
 }
 interface ExecResultOptions {
+  /** 去掉结果的首尾空格 */
   trim?: boolean;
+  /** 仅打印命令，不实际执行命令 */
   dryRun?: boolean;
+  /** log: 打印错误信息，返回 undefined; throw: 抛出错误; ignore: 返回 undefined */
   error?: 'log' | 'throw' | 'ignore';
 }
-type SpawnAsyncOptions<T = SpawnOptions> = T & ExecResultOptions;
-type ExecAsyncOptions<T = ExecOptions> = T & ExecResultOptions;
+type SpawnAsyncOptions = SpawnOptionsWithoutStdio & ExecResultOptions;
+type ExecAsyncOptions = ExecOptionsWithStringEncoding & ExecResultOptions;
 //#endregion
 //#region src/utils.d.ts
 declare const isValidPackageName: (packageName: string) => boolean;
@@ -68,15 +72,27 @@ declare const parseGitHubRepo: (url: string) => string[];
 declare const eol: (n?: number) => string;
 //#endregion
 //#region src/shell.d.ts
-declare const dim: (text: string) => string;
-declare const red: (text: string) => string;
-declare const yellow: (text: string) => string;
-declare const underline: (text: string) => string;
-declare const spawnAsync: <T = SpawnOptions>(cmd: string, args: string[], options?: SpawnAsyncOptions<T>) => Promise<string | undefined>;
-declare const execAsync: <T = ExecOptions>(cmd: string, options?: ExecAsyncOptions<T>) => Promise<string | undefined>;
+/** 异步执行 `spawn` 获取字符串类型的结果 */
+declare const spawnAsync: (cmd: string, args: string[], options?: SpawnAsyncOptions) => Promise<string | undefined>;
+type ExecAsync = {
+  (cmd: string, options?: ExecAsyncOptions): Promise<string | undefined>;
+  (cmd: string, args: string[], options?: ExecAsyncOptions): Promise<string | undefined>;
+};
+/** 异步执行 `exec` 获取字符串类型的结果 */
+declare const execAsync: ExecAsync;
+/** 基于 {@link spawnAsync} 实现 */
 declare const runGit: (args: string[], options?: SpawnAsyncOptions) => Promise<string | undefined>;
+/** 基于 {@link execAsync} 实现 */
 declare const runNpm: (args: string[], options?: ExecAsyncOptions) => Promise<string | undefined>;
-declare const fixArgs: (args: string) => string[];
+/** 基于 {@link spawnSync} 实现 */
+declare const runGitSync: (args: string[], options?: SpawnSyncOptionsWithStringEncoding) => string;
+/** 基于 {@link execSync} 实现 */
+declare const runNpmSync: (args: string[], options?: ExecSyncOptionsWithStringEncoding) => string;
+/** 将字符串以空格分割为数组 */
+declare const parseArgs: (args: string) => string[];
+/** 将数组以空格拼接为字符串 */
+declare const stringifyArgs: (args: string[]) => string;
+/** 支持所有支持 `--version` 命令的脚本查看版本 */
 declare const checkVersion: (cmd: string) => Promise<string | undefined>;
 //#endregion
 //#region src/joinUrl.d.ts
@@ -84,11 +100,15 @@ declare function joinUrl(...args: string[]): string;
 declare function joinUrl(input: readonly string[]): string;
 //#endregion
 //#region src/git.d.ts
+/** 判断指定目录是否是 git 仓库 */
 declare const isGitRepo: (dir?: string) => Promise<boolean>;
+/** 获取指定的 git 配置 */
 declare const getGitConfig: (key: string, global?: boolean) => Promise<string | undefined>;
+/** 获取 git 远程地址 */
 declare const getGitRemoteUrl: (remoteName?: string) => Promise<string | undefined>;
 //#endregion
 //#region src/npm.d.ts
+/** 获取指定包的版本 */
 declare const pkgVersion: (pkg: string) => Promise<string | undefined>;
 //#endregion
-export { CliOptions, ConfirmResult, CopyOptions, ExecAsyncOptions, ExecResultOptions, HttpLibrary, PkgInfo, PkgManager, SpawnAsyncOptions, YesOrNo, checkVersion, copyDirAsync, dim, editFile, editJsonFile, emptyDir, eol, execAsync, fixArgs, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, joinUrl, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, red, runCliForTest, runGit, runNpm, spawnAsync, toValidPackageName, toValidProjectName, underline, yellow };
+export { CliOptions, ConfirmResult, CopyOptions, ExecAsyncOptions, ExecResultOptions, HttpLibrary, PkgInfo, PkgManager, SpawnAsyncOptions, YesOrNo, checkVersion, copyDirAsync, editFile, editJsonFile, emptyDir, eol, execAsync, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, joinUrl, parseArgs, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, runCliForTest, runGit, runGitSync, runNpm, runNpmSync, spawnAsync, stringifyArgs, toValidPackageName, toValidProjectName };

package/dist/esm/index.mjs

@@ -1,4 +1,4 @@
-import { exec, spawn, spawnSync } from "node:child_process";
+import { exec, execSync, spawn, spawnSync } from "node:child_process";
 import { existsSync, readFileSync } from "node:fs";
 import { copyFile, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
 import { EOL } from "node:os";
@@ -135,26 +135,28 @@ const parseGitHubRepo = (url) => {
 const eol = (n = 1) => EOL.repeat(n);
 
 //#endregion
-//#region src/shell.ts
+//#region src/styleText.ts
 const dim = (text) => styleText(["dim"], text);
 const red = (text) => styleText(["red"], text);
-const yellow = (text) => styleText(["yellow"], text);
-const underline = (text) => styleText(["underline"], text);
+
+//#endregion
+//#region src/shell.ts
+/** 异步执行 `spawn` 获取字符串类型的结果 */
 const spawnAsync = (cmd, args, options) => {
 	return new Promise((resolve$1) => {
 		const { trim, error, dryRun, ...others } = options ?? {};
-		const fullCmd = [cmd, ...args].join(" ");
+		const fullCmd = stringifyArgs([cmd, ...args]);
 		if (dryRun) {
 			console.log(`${dim("[dry-run]")} ${fullCmd}`);
 			return resolve$1(void 0);
 		}
 		const child = spawn(cmd, args, { ...others });
 		let stdout = "";
-		child.stdout?.setEncoding("utf-8");
+		child.stdout.setEncoding("utf-8");
 		child.stdout?.on("data", (data) => stdout += trim ? data.trim() : data);
 		let stderr = "";
-		child.stderr?.setEncoding("utf-8");
-		child.stderr?.on("data", (data) => stderr += trim ? data.trim() : data);
+		child.stderr.setEncoding("utf-8");
+		child.stderr.on("data", (data) => stderr += trim ? data.trim() : data);
 		child.on("close", (code) => {
 			if (stderr) {
 				const err = `${red("spawnAsync")} ${dim(fullCmd)} ${stderr}`;
@@ -169,34 +171,65 @@ const spawnAsync = (cmd, args, options) => {
 		});
 	});
 };
-const execAsync = (cmd, options) => {
+/** 异步执行 `exec` 获取字符串类型的结果 */
+const execAsync = (cmd, argsOrOptions, maybeOptions) => {
 	return new Promise((resolve$1) => {
+		let command;
+		let options;
+		if (Array.isArray(argsOrOptions)) {
+			command = stringifyArgs([cmd, ...argsOrOptions]);
+			options = maybeOptions;
+		} else {
+			command = cmd;
+			options = argsOrOptions;
+		}
 		const { trim, dryRun, error, ...others } = options ?? {};
 		if (dryRun) {
-			console.log(`${dim("[dry-run]")} ${cmd}`);
+			console.log(`${dim("[dry-run]")} ${command}`);
 			return resolve$1(void 0);
 		}
-		exec(cmd, { ...others }, (err, stdout) => {
-			if (err) {
-				const msg = `${red("execAsync")} ${dim(cmd)} ${err.message}`;
+		exec(command, { ...others }, (stderr, stdout) => {
+			if (stderr) {
+				const err = `${red("execAsync")} ${dim(command)} ${stderr.message}`;
 				switch (error) {
 					case "log":
-						console.error(msg);
+						console.error(err);
 						break;
-					case "throw": throw new Error(msg);
+					case "throw": throw new Error(err);
 				}
 			}
-			resolve$1(err ? void 0 : trim ? stdout.trim() : stdout);
+			resolve$1(stderr ? void 0 : trim ? stdout.trim() : stdout);
 		});
 	});
 };
+/** 基于 {@link spawnAsync} 实现 */
 const runGit = async (args, options = { trim: true }) => {
 	return spawnAsync("git", args, options);
 };
+/** 基于 {@link execAsync} 实现 */
 const runNpm = (args, options = { trim: true }) => {
-	return execAsync(["npm", ...args].join(" "), options);
+	return execAsync("npm", args, options);
+};
+/** 基于 {@link spawnSync} 实现 */
+const runGitSync = (args, options) => {
+	const { stdout } = spawnSync("git", args, {
+		encoding: "utf-8",
+		...options
+	});
+	return stdout.toString().trim();
+};
+/** 基于 {@link execSync} 实现 */
+const runNpmSync = (args, options) => {
+	return execSync(stringifyArgs(["npm", ...args]), {
+		encoding: "utf-8",
+		...options
+	}).toString().trim();
 };
-const fixArgs = (args) => args.trim() ? args.trim().split(" ") : [];
+/** 将字符串以空格分割为数组 */
+const parseArgs = (args) => args.trim() ? args.trim().split(" ") : [];
+/** 将数组以空格拼接为字符串 */
+const stringifyArgs = (args) => args.length ? args.join(" ") : "";
+/** 支持所有支持 `--version` 命令的脚本查看版本 */
 const checkVersion = async (cmd) => {
 	return execAsync(`${cmd} --version`);
 };
@@ -234,14 +267,16 @@ function joinUrl(input) {
 
 //#endregion
 //#region src/git.ts
+/** 判断指定目录是否是 git 仓库 */
 const isGitRepo = async (dir) => {
-	return !!await runGit([
+	return "true" === await runGit([
 		"-C",
-		dir ? `./${dir}` : ".",
+		resolve(process.cwd(), dir || "."),
 		"rev-parse",
 		"--is-inside-work-tree"
 	]);
 };
+/** 获取指定的 git 配置 */
 const getGitConfig = (key, global = true) => {
 	return runGit([
 		"config",
@@ -249,6 +284,7 @@ const getGitConfig = (key, global = true) => {
 		key
 	]);
 };
+/** 获取 git 远程地址 */
 const getGitRemoteUrl = async (remoteName = "origin") => {
 	return runGit([
 		"remote",
@@ -263,6 +299,7 @@ const getGitRemoteUrl = async (remoteName = "origin") => {
 
 //#endregion
 //#region src/npm.ts
+/** 获取指定包的版本 */
 const pkgVersion = (pkg) => {
 	return runNpm([
 		"view",
@@ -272,4 +309,4 @@ const pkgVersion = (pkg) => {
 };
 
 //#endregion
-export { ConfirmResult, HttpLibrary, PkgManager, YesOrNo, checkVersion, copyDirAsync, dim, editFile, editJsonFile, emptyDir, eol, execAsync, fixArgs, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, joinUrl, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, red, runCliForTest, runGit, runNpm, spawnAsync, toValidPackageName, toValidProjectName, underline, yellow };
+export { ConfirmResult, HttpLibrary, PkgManager, YesOrNo, checkVersion, copyDirAsync, editFile, editJsonFile, emptyDir, eol, execAsync, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, joinUrl, parseArgs, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, runCliForTest, runGit, runGitSync, runNpm, runNpmSync, spawnAsync, stringifyArgs, toValidPackageName, toValidProjectName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peiyanlu/cli-utils",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Shared utils for building interactive Node.js CLI applications.",
   "license": "MIT",
   "type": "module",