@peiyanlu/cli-utils 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 离殇
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# @peiyanlu/cli-utils
+
+My project description.
+
+## Project setup
+
+```bash
+$ pnpm install
+```
+
+## Compile and run the project
+
+```bash
+# development
+$ pnpm run dev
+
+# production
+$ pnpm run build
+```
+
+## Run tests
+
+```bash
+# unit tests
+$ pnpm run test
+
+# e2e tests
+$ pnpm run test:e2e
+
+# test coverage
+$ pnpm run test:cov
+```
+

package/dist/cjs/index.cjs

@@ -0,0 +1,163 @@
+let node_child_process = require("node:child_process");
+let node_fs = require("node:fs");
+let node_fs_promises = require("node:fs/promises");
+let node_path = require("node:path");
+
+//#region src/enums.ts
+let PkgManager = /* @__PURE__ */ function(PkgManager$1) {
+	PkgManager$1["NPM"] = "npm";
+	PkgManager$1["YARN"] = "yarn";
+	PkgManager$1["PNPM"] = "pnpm";
+	return PkgManager$1;
+}({});
+/**
+* @deprecated Use `ConfirmResult` instead.
+*/
+let YesOrNo = /* @__PURE__ */ function(YesOrNo$1) {
+	YesOrNo$1["Yes"] = "yes";
+	YesOrNo$1["No"] = "no";
+	YesOrNo$1["Ignore"] = "ignore";
+	return YesOrNo$1;
+}({});
+let ConfirmResult = /* @__PURE__ */ function(ConfirmResult$1) {
+	ConfirmResult$1["YES"] = "yes";
+	ConfirmResult$1["NO"] = "no";
+	ConfirmResult$1["IGNORE"] = "ignore";
+	return ConfirmResult$1;
+}({});
+let HttpLibrary = /* @__PURE__ */ function(HttpLibrary$1) {
+	HttpLibrary$1["EXPRESS"] = "express";
+	HttpLibrary$1["FASTIFY"] = "fastify";
+	HttpLibrary$1["KOA"] = "koa";
+	HttpLibrary$1["HONO"] = "hono";
+	return HttpLibrary$1;
+}({});
+
+//#endregion
+//#region src/utils.ts
+const execAsync = (cmd) => {
+	return new Promise((r) => {
+		(0, node_child_process.exec)(cmd, (err, stdout) => r(err ? void 0 : stdout.trim()));
+	});
+};
+const pkgVersion = (pkg) => {
+	return execAsync(`npm view ${pkg} version`);
+};
+const checkVersion = async (cmd) => {
+	return execAsync(`${cmd} --version`);
+};
+const isValidPackageName = (packageName) => {
+	return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(packageName);
+};
+const toValidPackageName = (packageName) => packageName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z\d\-~]+/g, "-");
+const toValidProjectName = (projectName) => projectName.trim().replace(/\/+$/g, "");
+const emptyDir = async (dir, ignore = []) => {
+	if (!(0, node_fs.existsSync)(dir)) return false;
+	for (const file of await (0, node_fs_promises.readdir)(dir)) {
+		if (ignore.includes(file)) continue;
+		await (0, node_fs_promises.rm)((0, node_path.resolve)(dir, file), {
+			recursive: true,
+			force: true
+		});
+	}
+	return true;
+};
+const isEmpty = async (path, ignore = []) => {
+	return (await (0, node_fs_promises.readdir)(path)).filter((f) => !ignore.includes(f)).length === 0;
+};
+const editFile = async (file, callback) => {
+	if (!(0, node_fs.existsSync)(file)) return;
+	return (0, node_fs_promises.writeFile)(file, callback(await (0, node_fs_promises.readFile)(file, "utf-8")), "utf-8");
+};
+const editJsonFile = (file, callback) => {
+	return editFile(file, (str) => {
+		try {
+			const json = JSON.parse(str);
+			callback(json);
+			return JSON.stringify(json, null, 2);
+		} catch (e) {
+			console.error(e);
+			return str;
+		}
+	});
+};
+const isGitRepo = async (dir) => {
+	return !!await execAsync(`git -C "${dir ? `./${dir}` : "."}" rev-parse --is-inside-work-tree`);
+};
+const readSubDirs = async (source, ignore = []) => {
+	return (await (0, node_fs_promises.readdir)(source, { withFileTypes: true })).filter((k) => k.isDirectory() && !ignore.includes(k.name)).map((dir) => dir.name);
+};
+const getGitConfig = (key, global = true) => {
+	return execAsync(`git config ${global ? "--global" : ""} ${key}`);
+};
+const copyDirAsync = async (src, dest, options) => {
+	await (0, node_fs_promises.mkdir)(dest, { recursive: true });
+	const entries = await (0, node_fs_promises.readdir)(src, { withFileTypes: true });
+	for (const entry of entries) {
+		const name = entry.name;
+		const isDir = entry.isDirectory();
+		const { rename = {}, skips = [] } = options;
+		const relName = rename[name] ?? name;
+		if (skips.some((rule) => rule(name, isDir))) continue;
+		const from = (0, node_path.join)(src, name);
+		const to = (0, node_path.join)(dest, relName);
+		if (isDir) await copyDirAsync(from, to, options);
+		else await (0, node_fs_promises.copyFile)(from, to);
+	}
+};
+const readJsonFile = (file) => {
+	if (!(0, node_fs.existsSync)(file)) return {};
+	try {
+		return JSON.parse((0, node_fs.readFileSync)(file, "utf-8"));
+	} catch (e) {
+		return {};
+	}
+};
+/**
+* 通过包管理器执行脚本时生效
+*
+* UserAgent: `process.env.npm_config_user_agent`
+* @param {string | undefined} userAgent
+* @returns {PkgInfo | undefined}
+*/
+const pkgFromUserAgent = (userAgent) => {
+	if (!userAgent) return void 0;
+	const [name, version] = userAgent.split(" ")[0].split("/");
+	return {
+		name,
+		version
+	};
+};
+const runCli = (path, args, options) => {
+	return (0, node_child_process.spawnSync)("node", [path, ...args], {
+		env: {
+			...process.env,
+			_VITE_TEST_CLI: "true"
+		},
+		encoding: "utf-8",
+		...options
+	});
+};
+
+//#endregion
+exports.ConfirmResult = ConfirmResult;
+exports.HttpLibrary = HttpLibrary;
+exports.PkgManager = PkgManager;
+exports.YesOrNo = YesOrNo;
+exports.checkVersion = checkVersion;
+exports.copyDirAsync = copyDirAsync;
+exports.editFile = editFile;
+exports.editJsonFile = editJsonFile;
+exports.emptyDir = emptyDir;
+exports.execAsync = execAsync;
+exports.getGitConfig = getGitConfig;
+exports.isEmpty = isEmpty;
+exports.isGitRepo = isGitRepo;
+exports.isValidPackageName = isValidPackageName;
+exports.pkgFromUserAgent = pkgFromUserAgent;
+exports.pkgVersion = pkgVersion;
+exports.readJsonFile = readJsonFile;
+exports.readSubDirs = readSubDirs;
+exports.runCli = runCli;
+exports.toValidPackageName = toValidPackageName;
+exports.toValidProjectName = toValidProjectName;

package/dist/cjs/index.d.cts

@@ -0,0 +1,67 @@
+import * as child_process0 from "child_process";
+import { SpawnSyncOptionsWithStringEncoding } from "child_process";
+
+//#region src/enums.d.ts
+declare enum PkgManager {
+  NPM = "npm",
+  YARN = "yarn",
+  PNPM = "pnpm",
+}
+/**
+ * @deprecated Use `ConfirmResult` instead.
+ */
+declare enum YesOrNo {
+  Yes = "yes",
+  No = "no",
+  Ignore = "ignore",
+}
+declare enum ConfirmResult {
+  YES = "yes",
+  NO = "no",
+  IGNORE = "ignore",
+}
+declare enum HttpLibrary {
+  EXPRESS = "express",
+  FASTIFY = "fastify",
+  KOA = "koa",
+  HONO = "hono",
+}
+//#endregion
+//#region src/types.d.ts
+interface CopyOptions {
+  rename?: Record<string, string>;
+  skips?: ((name: string, isDir: boolean) => boolean)[];
+}
+type CliOptions<T = string | boolean> = Record<string, T>;
+interface PkgInfo {
+  name: string;
+  version: string;
+}
+//#endregion
+//#region src/utils.d.ts
+declare const execAsync: (cmd: string) => Promise<string | undefined>;
+declare const pkgVersion: (pkg: string) => Promise<string | undefined>;
+declare const checkVersion: (cmd: string) => Promise<string | undefined>;
+declare const isValidPackageName: (packageName: string) => boolean;
+declare const toValidPackageName: (packageName: string) => string;
+declare const toValidProjectName: (projectName: string) => string;
+declare const emptyDir: (dir: string, ignore?: string[]) => Promise<boolean>;
+declare const isEmpty: (path: string, ignore?: string[]) => Promise<boolean>;
+declare const editFile: (file: string, callback: (content: string) => string) => Promise<void>;
+declare const editJsonFile: <T extends Record<string, any>>(file: string, callback: (json: T) => void) => Promise<void>;
+declare const isGitRepo: (dir?: string) => Promise<boolean>;
+declare const readSubDirs: (source: string, ignore?: string[]) => Promise<string[]>;
+declare const getGitConfig: (key: string, global?: boolean) => Promise<string | undefined>;
+declare const copyDirAsync: (src: string, dest: string, options: CopyOptions) => Promise<void>;
+declare const readJsonFile: <T extends Record<string, any>>(file: string) => T;
+/**
+ * 通过包管理器执行脚本时生效
+ *
+ * UserAgent: `process.env.npm_config_user_agent`
+ * @param {string | undefined} userAgent
+ * @returns {PkgInfo | undefined}
+ */
+declare const pkgFromUserAgent: (userAgent: string | undefined) => PkgInfo | undefined;
+declare const runCli: (path: string, args: string[], options?: SpawnSyncOptionsWithStringEncoding) => child_process0.SpawnSyncReturns<string>;
+//#endregion
+export { CliOptions, ConfirmResult, CopyOptions, HttpLibrary, PkgInfo, PkgManager, YesOrNo, checkVersion, copyDirAsync, editFile, editJsonFile, emptyDir, execAsync, getGitConfig, isEmpty, isGitRepo, isValidPackageName, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, runCli, toValidPackageName, toValidProjectName };

package/dist/esm/index.d.mts

@@ -0,0 +1,67 @@
+import * as child_process0 from "child_process";
+import { SpawnSyncOptionsWithStringEncoding } from "child_process";
+
+//#region src/enums.d.ts
+declare enum PkgManager {
+  NPM = "npm",
+  YARN = "yarn",
+  PNPM = "pnpm",
+}
+/**
+ * @deprecated Use `ConfirmResult` instead.
+ */
+declare enum YesOrNo {
+  Yes = "yes",
+  No = "no",
+  Ignore = "ignore",
+}
+declare enum ConfirmResult {
+  YES = "yes",
+  NO = "no",
+  IGNORE = "ignore",
+}
+declare enum HttpLibrary {
+  EXPRESS = "express",
+  FASTIFY = "fastify",
+  KOA = "koa",
+  HONO = "hono",
+}
+//#endregion
+//#region src/types.d.ts
+interface CopyOptions {
+  rename?: Record<string, string>;
+  skips?: ((name: string, isDir: boolean) => boolean)[];
+}
+type CliOptions<T = string | boolean> = Record<string, T>;
+interface PkgInfo {
+  name: string;
+  version: string;
+}
+//#endregion
+//#region src/utils.d.ts
+declare const execAsync: (cmd: string) => Promise<string | undefined>;
+declare const pkgVersion: (pkg: string) => Promise<string | undefined>;
+declare const checkVersion: (cmd: string) => Promise<string | undefined>;
+declare const isValidPackageName: (packageName: string) => boolean;
+declare const toValidPackageName: (packageName: string) => string;
+declare const toValidProjectName: (projectName: string) => string;
+declare const emptyDir: (dir: string, ignore?: string[]) => Promise<boolean>;
+declare const isEmpty: (path: string, ignore?: string[]) => Promise<boolean>;
+declare const editFile: (file: string, callback: (content: string) => string) => Promise<void>;
+declare const editJsonFile: <T extends Record<string, any>>(file: string, callback: (json: T) => void) => Promise<void>;
+declare const isGitRepo: (dir?: string) => Promise<boolean>;
+declare const readSubDirs: (source: string, ignore?: string[]) => Promise<string[]>;
+declare const getGitConfig: (key: string, global?: boolean) => Promise<string | undefined>;
+declare const copyDirAsync: (src: string, dest: string, options: CopyOptions) => Promise<void>;
+declare const readJsonFile: <T extends Record<string, any>>(file: string) => T;
+/**
+ * 通过包管理器执行脚本时生效
+ *
+ * UserAgent: `process.env.npm_config_user_agent`
+ * @param {string | undefined} userAgent
+ * @returns {PkgInfo | undefined}
+ */
+declare const pkgFromUserAgent: (userAgent: string | undefined) => PkgInfo | undefined;
+declare const runCli: (path: string, args: string[], options?: SpawnSyncOptionsWithStringEncoding) => child_process0.SpawnSyncReturns<string>;
+//#endregion
+export { CliOptions, ConfirmResult, CopyOptions, HttpLibrary, PkgInfo, PkgManager, YesOrNo, checkVersion, copyDirAsync, editFile, editJsonFile, emptyDir, execAsync, getGitConfig, isEmpty, isGitRepo, isValidPackageName, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, runCli, toValidPackageName, toValidProjectName };

package/dist/esm/index.mjs

@@ -0,0 +1,143 @@
+import { exec, spawnSync } from "node:child_process";
+import { existsSync, readFileSync } from "node:fs";
+import { copyFile, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
+import { join, resolve } from "node:path";
+
+//#region src/enums.ts
+let PkgManager = /* @__PURE__ */ function(PkgManager$1) {
+	PkgManager$1["NPM"] = "npm";
+	PkgManager$1["YARN"] = "yarn";
+	PkgManager$1["PNPM"] = "pnpm";
+	return PkgManager$1;
+}({});
+/**
+* @deprecated Use `ConfirmResult` instead.
+*/
+let YesOrNo = /* @__PURE__ */ function(YesOrNo$1) {
+	YesOrNo$1["Yes"] = "yes";
+	YesOrNo$1["No"] = "no";
+	YesOrNo$1["Ignore"] = "ignore";
+	return YesOrNo$1;
+}({});
+let ConfirmResult = /* @__PURE__ */ function(ConfirmResult$1) {
+	ConfirmResult$1["YES"] = "yes";
+	ConfirmResult$1["NO"] = "no";
+	ConfirmResult$1["IGNORE"] = "ignore";
+	return ConfirmResult$1;
+}({});
+let HttpLibrary = /* @__PURE__ */ function(HttpLibrary$1) {
+	HttpLibrary$1["EXPRESS"] = "express";
+	HttpLibrary$1["FASTIFY"] = "fastify";
+	HttpLibrary$1["KOA"] = "koa";
+	HttpLibrary$1["HONO"] = "hono";
+	return HttpLibrary$1;
+}({});
+
+//#endregion
+//#region src/utils.ts
+const execAsync = (cmd) => {
+	return new Promise((r) => {
+		exec(cmd, (err, stdout) => r(err ? void 0 : stdout.trim()));
+	});
+};
+const pkgVersion = (pkg) => {
+	return execAsync(`npm view ${pkg} version`);
+};
+const checkVersion = async (cmd) => {
+	return execAsync(`${cmd} --version`);
+};
+const isValidPackageName = (packageName) => {
+	return /^(?:@[a-z\d\-*~][a-z\d\-*._~]*\/)?[a-z\d\-~][a-z\d\-._~]*$/.test(packageName);
+};
+const toValidPackageName = (packageName) => packageName.trim().toLowerCase().replace(/\s+/g, "-").replace(/^[._]/, "").replace(/[^a-z\d\-~]+/g, "-");
+const toValidProjectName = (projectName) => projectName.trim().replace(/\/+$/g, "");
+const emptyDir = async (dir, ignore = []) => {
+	if (!existsSync(dir)) return false;
+	for (const file of await readdir(dir)) {
+		if (ignore.includes(file)) continue;
+		await rm(resolve(dir, file), {
+			recursive: true,
+			force: true
+		});
+	}
+	return true;
+};
+const isEmpty = async (path, ignore = []) => {
+	return (await readdir(path)).filter((f) => !ignore.includes(f)).length === 0;
+};
+const editFile = async (file, callback) => {
+	if (!existsSync(file)) return;
+	return writeFile(file, callback(await readFile(file, "utf-8")), "utf-8");
+};
+const editJsonFile = (file, callback) => {
+	return editFile(file, (str) => {
+		try {
+			const json = JSON.parse(str);
+			callback(json);
+			return JSON.stringify(json, null, 2);
+		} catch (e) {
+			console.error(e);
+			return str;
+		}
+	});
+};
+const isGitRepo = async (dir) => {
+	return !!await execAsync(`git -C "${dir ? `./${dir}` : "."}" rev-parse --is-inside-work-tree`);
+};
+const readSubDirs = async (source, ignore = []) => {
+	return (await readdir(source, { withFileTypes: true })).filter((k) => k.isDirectory() && !ignore.includes(k.name)).map((dir) => dir.name);
+};
+const getGitConfig = (key, global = true) => {
+	return execAsync(`git config ${global ? "--global" : ""} ${key}`);
+};
+const copyDirAsync = async (src, dest, options) => {
+	await mkdir(dest, { recursive: true });
+	const entries = await readdir(src, { withFileTypes: true });
+	for (const entry of entries) {
+		const name = entry.name;
+		const isDir = entry.isDirectory();
+		const { rename = {}, skips = [] } = options;
+		const relName = rename[name] ?? name;
+		if (skips.some((rule) => rule(name, isDir))) continue;
+		const from = join(src, name);
+		const to = join(dest, relName);
+		if (isDir) await copyDirAsync(from, to, options);
+		else await copyFile(from, to);
+	}
+};
+const readJsonFile = (file) => {
+	if (!existsSync(file)) return {};
+	try {
+		return JSON.parse(readFileSync(file, "utf-8"));
+	} catch (e) {
+		return {};
+	}
+};
+/**
+* 通过包管理器执行脚本时生效
+*
+* UserAgent: `process.env.npm_config_user_agent`
+* @param {string | undefined} userAgent
+* @returns {PkgInfo | undefined}
+*/
+const pkgFromUserAgent = (userAgent) => {
+	if (!userAgent) return void 0;
+	const [name, version] = userAgent.split(" ")[0].split("/");
+	return {
+		name,
+		version
+	};
+};
+const runCli = (path, args, options) => {
+	return spawnSync("node", [path, ...args], {
+		env: {
+			...process.env,
+			_VITE_TEST_CLI: "true"
+		},
+		encoding: "utf-8",
+		...options
+	});
+};
+
+//#endregion
+export { ConfirmResult, HttpLibrary, PkgManager, YesOrNo, checkVersion, copyDirAsync, editFile, editJsonFile, emptyDir, execAsync, getGitConfig, isEmpty, isGitRepo, isValidPackageName, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, runCli, toValidPackageName, toValidProjectName };

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@peiyanlu/cli-utils",
+  "version": "0.0.1",
+  "description": "Shared utils for building interactive Node.js CLI applications.",
+  "license": "MIT",
+  "type": "module",
+  "private": false,
+  "main": "./dist/cjs/index.cjs",
+  "types": "./dist/cjs/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.mjs",
+      "types": "./dist/esm/index.d.mts"
+    },
+    "./package.json": "./package.json"
+  },
+  "devDependencies": {
+    "@release-it/conventional-changelog": "^10.0.2",
+    "@types/node": "^24.10.3",
+    "@vitest/coverage-v8": "^4.0.15",
+    "release-it": "^19.0.2",
+    "release-it-pnpm": "^4.6.6",
+    "tsdown": "^0.18.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.15"
+  },
+  "author": {
+    "name": "YanluPei",
+    "email": "peiyanlu@vip.qq.com"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "typescript",
+    "lib"
+  ],
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/peiyanlu/cli-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/peiyanlu/cli-utils/issues"
+  },
+  "homepage": "https://github.com/peiyanlu/cli-utils#readme",
+  "scripts": {
+    "dev": "tsdown -w",
+    "build": "tsdown",
+    "prepublish": "tsdown",
+    "release": "release-it",
+    "test": "vitest run",
+    "test:e2e": "vitest run -c vitest.config.e2e.mts",
+    "test:cov": "vitest run --coverage"
+  }
+}