@peiyanlu/cli-utils 0.0.2 → 0.0.3

package/dist/cjs/index.cjs

@@ -1,6 +1,7 @@
 let node_child_process = require("node:child_process");
 let node_fs = require("node:fs");
 let node_fs_promises = require("node:fs/promises");
+let node_os = require("node:os");
 let node_path = require("node:path");
 let node_util = require("node:util");
 
@@ -125,16 +126,20 @@ const isTestFile = (name) => {
 		/^vitest([-.])(.*)\.m?(ts|js)$/
 	].some((reg) => reg.test(name));
 };
+/** 解析 Github 链接获取 owner 和 repo */
 const parseGitHubRepo = (url) => {
 	const match = url.trim().match(/github(?:\.com)?[:/](.+?)\/(.+?)(?:[#/?].+?)?(?:\.git)?$/);
 	return match ? match.slice(1, 3) : [];
 };
+/** 基于 EOL 的可多换行函数 */
+const eol = (n = 1) => node_os.EOL.repeat(n);
 
 //#endregion
 //#region src/shell.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);
 const spawnAsync = (cmd, args, options) => {
 	return new Promise((resolve$1) => {
 		const { trim, error, dryRun, ...others } = options ?? {};
@@ -185,12 +190,50 @@ const execAsync = (cmd, options) => {
 		});
 	});
 };
-const runGit = async (args, trim = true) => {
-	return spawnAsync("git", args, { trim });
+const runGit = async (args, options = { trim: true }) => {
+	return spawnAsync("git", args, options);
 };
-const runNpm = (args) => {
-	return execAsync(["npm", ...args].join(" "));
+const runNpm = (args, options = { trim: true }) => {
+	return execAsync(["npm", ...args].join(" "), options);
 };
+const fixArgs = (args) => args.trim() ? args.trim().split(" ") : [];
+const checkVersion = async (cmd) => {
+	return execAsync(`${cmd} --version`);
+};
+
+//#endregion
+//#region src/joinUrl.ts
+function joinUrl(input) {
+	const temps = Array.isArray(input) ? input : [...arguments];
+	if (temps.length === 0) return "";
+	const result = [];
+	const parts = [...temps];
+	/** 协议正则 */
+	const PROTOCOL_RE = /^[^/:]+:\/*$/;
+	const FILE_PROTOCOL_RE = /^file:\/\/\//;
+	if (PROTOCOL_RE.test(parts[0]) && parts.length > 1) {
+		parts[1] = parts[0] + parts[1];
+		parts.shift();
+	}
+	if (FILE_PROTOCOL_RE.test(parts[0])) parts[0] = parts[0].replace(/^([^/:]+):\/*/, "$1:///");
+	else parts[0] = parts[0].replace(/^([^/:]+):\/*/, "$1://");
+	parts.forEach((part, index) => {
+		if (!part) return;
+		let segment = part;
+		if (index > 0) segment = segment.replace(/^\/+/, "");
+		if (index < parts.length - 1) segment = segment.replace(/\/+$/, "");
+		else segment = segment.replace(/\/+$/, "/");
+		result.push(segment);
+	});
+	let url = result.join("/");
+	url = url.replace(/\/(\?|&|#[^!])/g, "$1");
+	const [base, ...queryParts] = url.split("?");
+	url = base + (queryParts.length ? "?" + queryParts.join("&") : "");
+	return url;
+}
+
+//#endregion
+//#region src/git.ts
 const isGitRepo = async (dir) => {
 	return !!await runGit([
 		"-C",
@@ -217,6 +260,9 @@ const getGitRemoteUrl = async (remoteName = "origin") => {
 		`remote.${remoteName}.url`
 	]));
 };
+
+//#endregion
+//#region src/npm.ts
 const pkgVersion = (pkg) => {
 	return runNpm([
 		"view",
@@ -224,9 +270,6 @@ const pkgVersion = (pkg) => {
 		"version"
 	]);
 };
-const checkVersion = async (cmd) => {
-	return execAsync(`${cmd} --version`);
-};
 
 //#endregion
 exports.ConfirmResult = ConfirmResult;
@@ -239,13 +282,16 @@ 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;
 exports.isGitRepo = isGitRepo;
 exports.isTestFile = isTestFile;
 exports.isValidPackageName = isValidPackageName;
+exports.joinUrl = joinUrl;
 exports.parseGitHubRepo = parseGitHubRepo;
 exports.pkgFromUserAgent = pkgFromUserAgent;
 exports.pkgVersion = pkgVersion;
@@ -258,4 +304,5 @@ exports.runNpm = runNpm;
 exports.spawnAsync = spawnAsync;
 exports.toValidPackageName = toValidPackageName;
 exports.toValidProjectName = toValidProjectName;
+exports.underline = underline;
 exports.yellow = yellow;

package/dist/cjs/index.d.cts

@@ -62,20 +62,33 @@ declare const pkgFromUserAgent: (userAgent: string | undefined) => PkgInfo | und
 declare const runCliForTest: (path: string, args: string[], options?: SpawnSyncOptionsWithStringEncoding) => child_process0.SpawnSyncReturns<string>;
 /** 判断测试文件（夹） */
 declare const isTestFile: (name: string) => boolean;
+/** 解析 Github 链接获取 owner 和 repo */
 declare const parseGitHubRepo: (url: string) => string[];
+/** 基于 EOL 的可多换行函数 */
+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>;
-declare const runGit: (args: string[], trim?: boolean) => Promise<string | undefined>;
-declare const runNpm: (args: string[]) => Promise<string | undefined>;
+declare const runGit: (args: string[], options?: SpawnAsyncOptions) => Promise<string | undefined>;
+declare const runNpm: (args: string[], options?: ExecAsyncOptions) => Promise<string | undefined>;
+declare const fixArgs: (args: string) => string[];
+declare const checkVersion: (cmd: string) => Promise<string | undefined>;
+//#endregion
+//#region src/joinUrl.d.ts
+declare function joinUrl(...args: string[]): string;
+declare function joinUrl(input: readonly string[]): string;
+//#endregion
+//#region src/git.d.ts
 declare const isGitRepo: (dir?: string) => Promise<boolean>;
 declare const getGitConfig: (key: string, global?: boolean) => Promise<string | undefined>;
 declare const getGitRemoteUrl: (remoteName?: string) => Promise<string | undefined>;
+//#endregion
+//#region src/npm.d.ts
 declare const pkgVersion: (pkg: string) => Promise<string | undefined>;
-declare const checkVersion: (cmd: string) => Promise<string | undefined>;
 //#endregion
-export { CliOptions, ConfirmResult, CopyOptions, ExecAsyncOptions, ExecResultOptions, HttpLibrary, PkgInfo, PkgManager, SpawnAsyncOptions, YesOrNo, checkVersion, copyDirAsync, dim, editFile, editJsonFile, emptyDir, execAsync, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, red, runCliForTest, runGit, runNpm, spawnAsync, toValidPackageName, toValidProjectName, yellow };
+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 };

package/dist/esm/index.d.mts

@@ -62,20 +62,33 @@ declare const pkgFromUserAgent: (userAgent: string | undefined) => PkgInfo | und
 declare const runCliForTest: (path: string, args: string[], options?: SpawnSyncOptionsWithStringEncoding) => child_process0.SpawnSyncReturns<string>;
 /** 判断测试文件（夹） */
 declare const isTestFile: (name: string) => boolean;
+/** 解析 Github 链接获取 owner 和 repo */
 declare const parseGitHubRepo: (url: string) => string[];
+/** 基于 EOL 的可多换行函数 */
+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>;
-declare const runGit: (args: string[], trim?: boolean) => Promise<string | undefined>;
-declare const runNpm: (args: string[]) => Promise<string | undefined>;
+declare const runGit: (args: string[], options?: SpawnAsyncOptions) => Promise<string | undefined>;
+declare const runNpm: (args: string[], options?: ExecAsyncOptions) => Promise<string | undefined>;
+declare const fixArgs: (args: string) => string[];
+declare const checkVersion: (cmd: string) => Promise<string | undefined>;
+//#endregion
+//#region src/joinUrl.d.ts
+declare function joinUrl(...args: string[]): string;
+declare function joinUrl(input: readonly string[]): string;
+//#endregion
+//#region src/git.d.ts
 declare const isGitRepo: (dir?: string) => Promise<boolean>;
 declare const getGitConfig: (key: string, global?: boolean) => Promise<string | undefined>;
 declare const getGitRemoteUrl: (remoteName?: string) => Promise<string | undefined>;
+//#endregion
+//#region src/npm.d.ts
 declare const pkgVersion: (pkg: string) => Promise<string | undefined>;
-declare const checkVersion: (cmd: string) => Promise<string | undefined>;
 //#endregion
-export { CliOptions, ConfirmResult, CopyOptions, ExecAsyncOptions, ExecResultOptions, HttpLibrary, PkgInfo, PkgManager, SpawnAsyncOptions, YesOrNo, checkVersion, copyDirAsync, dim, editFile, editJsonFile, emptyDir, execAsync, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, red, runCliForTest, runGit, runNpm, spawnAsync, toValidPackageName, toValidProjectName, yellow };
+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 };

package/dist/esm/index.mjs

@@ -1,6 +1,7 @@
 import { exec, 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";
 import { join, resolve } from "node:path";
 import { styleText } from "node:util";
 
@@ -125,16 +126,20 @@ const isTestFile = (name) => {
 		/^vitest([-.])(.*)\.m?(ts|js)$/
 	].some((reg) => reg.test(name));
 };
+/** 解析 Github 链接获取 owner 和 repo */
 const parseGitHubRepo = (url) => {
 	const match = url.trim().match(/github(?:\.com)?[:/](.+?)\/(.+?)(?:[#/?].+?)?(?:\.git)?$/);
 	return match ? match.slice(1, 3) : [];
 };
+/** 基于 EOL 的可多换行函数 */
+const eol = (n = 1) => EOL.repeat(n);
 
 //#endregion
 //#region src/shell.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);
 const spawnAsync = (cmd, args, options) => {
 	return new Promise((resolve$1) => {
 		const { trim, error, dryRun, ...others } = options ?? {};
@@ -185,12 +190,50 @@ const execAsync = (cmd, options) => {
 		});
 	});
 };
-const runGit = async (args, trim = true) => {
-	return spawnAsync("git", args, { trim });
+const runGit = async (args, options = { trim: true }) => {
+	return spawnAsync("git", args, options);
 };
-const runNpm = (args) => {
-	return execAsync(["npm", ...args].join(" "));
+const runNpm = (args, options = { trim: true }) => {
+	return execAsync(["npm", ...args].join(" "), options);
 };
+const fixArgs = (args) => args.trim() ? args.trim().split(" ") : [];
+const checkVersion = async (cmd) => {
+	return execAsync(`${cmd} --version`);
+};
+
+//#endregion
+//#region src/joinUrl.ts
+function joinUrl(input) {
+	const temps = Array.isArray(input) ? input : [...arguments];
+	if (temps.length === 0) return "";
+	const result = [];
+	const parts = [...temps];
+	/** 协议正则 */
+	const PROTOCOL_RE = /^[^/:]+:\/*$/;
+	const FILE_PROTOCOL_RE = /^file:\/\/\//;
+	if (PROTOCOL_RE.test(parts[0]) && parts.length > 1) {
+		parts[1] = parts[0] + parts[1];
+		parts.shift();
+	}
+	if (FILE_PROTOCOL_RE.test(parts[0])) parts[0] = parts[0].replace(/^([^/:]+):\/*/, "$1:///");
+	else parts[0] = parts[0].replace(/^([^/:]+):\/*/, "$1://");
+	parts.forEach((part, index) => {
+		if (!part) return;
+		let segment = part;
+		if (index > 0) segment = segment.replace(/^\/+/, "");
+		if (index < parts.length - 1) segment = segment.replace(/\/+$/, "");
+		else segment = segment.replace(/\/+$/, "/");
+		result.push(segment);
+	});
+	let url = result.join("/");
+	url = url.replace(/\/(\?|&|#[^!])/g, "$1");
+	const [base, ...queryParts] = url.split("?");
+	url = base + (queryParts.length ? "?" + queryParts.join("&") : "");
+	return url;
+}
+
+//#endregion
+//#region src/git.ts
 const isGitRepo = async (dir) => {
 	return !!await runGit([
 		"-C",
@@ -217,6 +260,9 @@ const getGitRemoteUrl = async (remoteName = "origin") => {
 		`remote.${remoteName}.url`
 	]));
 };
+
+//#endregion
+//#region src/npm.ts
 const pkgVersion = (pkg) => {
 	return runNpm([
 		"view",
@@ -224,9 +270,6 @@ const pkgVersion = (pkg) => {
 		"version"
 	]);
 };
-const checkVersion = async (cmd) => {
-	return execAsync(`${cmd} --version`);
-};
 
 //#endregion
-export { ConfirmResult, HttpLibrary, PkgManager, YesOrNo, checkVersion, copyDirAsync, dim, editFile, editJsonFile, emptyDir, execAsync, getGitConfig, getGitRemoteUrl, isEmpty, isGitRepo, isTestFile, isValidPackageName, parseGitHubRepo, pkgFromUserAgent, pkgVersion, readJsonFile, readSubDirs, red, runCliForTest, runGit, runNpm, spawnAsync, toValidPackageName, toValidProjectName, yellow };
+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 };

package/package.json

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