@quiteer/scripts 0.0.6 → 0.0.9

package/dist/index.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import cac from "cac";
 import { bgGreen, bgRed, blue, gray, green, lightBlue, lightCyan, lightGreen, red, white, yellow } from "kolorist";
-import { access, readFile, writeFile } from "node:fs/promises";
+import { access, readFile, readdir, writeFile } from "node:fs/promises";
 import path from "node:path";
 import process from "node:process";
 import { execa } from "execa";
@@ -12,7 +12,7 @@ import enquirer from "enquirer";
 import { versionBump } from "bumpp";
 
 //#region package.json
-var version = "0.0.5";
+var version = "0.0.9";
 
 //#endregion
 //#region src/locales/changelog.ts
@@ -213,18 +213,40 @@ async function getCommitsInRange(range) {
 	])).split("\n").filter(Boolean).map(parseCommit).filter((x) => !!x);
 }
 /**
-* 读取 package homepage 以生成提交链接
-* @returns 仓库主页 URL
+* 读取 package homepage（若为 GitHub Pages URL，转换为仓库地址）
+* @returns 可能的仓库主页 URL
 */
 async function readHomepage() {
 	try {
 		const content = await readFile(path.join(process.cwd(), "scripts", "package.json"), "utf8");
 		const json = JSON.parse(content);
-		return typeof json.homepage === "string" ? json.homepage.replace(/\/$/, "") : void 0;
+		const home = typeof json.homepage === "string" ? json.homepage.replace(/\/$/, "") : void 0;
+		if (!home) return void 0;
+		const m = home.match(/^https:\/\/([\w-]+)\.github\.io\/([\w.-]+)\//);
+		if (m) return `https://github.com/${m[1]}/${m[2]}`;
+		return home;
 	} catch {
 		return;
 	}
 }
+/**
+* 获取 Web 版仓库地址（优先使用 git remote，回退到 homepage 推断）
+* @returns 仓库 Web URL（如 https://github.com/<owner>/<repo>）
+*/
+async function getRepoWebUrl() {
+	try {
+		const remote = await execCommand("git", [
+			"remote",
+			"get-url",
+			"origin"
+		]);
+		if (remote) {
+			if (remote.startsWith("git@github.com:")) return `https://github.com/${remote.replace("git@github.com:", "").replace(/\.git$/, "")}`;
+			if (remote.startsWith("https://github.com/")) return `https://github.com/${remote.replace("https://github.com/", "").replace(/\.git$/, "")}`;
+		}
+	} catch {}
+	return await readHomepage();
+}
 async function prependFile(filePath, content) {
 	try {
 		await access(filePath);
@@ -313,9 +335,18 @@ function formatSection(title, date, items, repoUrl, lang) {
 				lines.push(`- ${typeIcon} ${typeLabel} ${scopeFmt ? `${scopeFmt}: ` : ""}${it.description}`);
 				lines.push(`  > **🕒  ${time}** · \`➕${it.added}\` / \`➖${it.deleted}\``);
 				lines.push(`  > \`👤 ${it.author}\` ${email}${link}`);
-				for (const f of it.filesAdded ?? []) lines.push(`  - ➕ \`${f}\``);
-				for (const f of it.filesModified ?? []) lines.push(`  - ✏️ \`${f}\``);
-				for (const f of it.filesDeleted ?? []) lines.push(`  - 🗑️ ~~~~\`${f}\`~~~~`);
+				for (const f of it.filesAdded ?? []) {
+					const url = repoUrl ? `${repoUrl}/blob/${it.hash}/${f}` : void 0;
+					lines.push(url ? `  - ➕ [\`${f}\`](${url})` : `  - ➕ \`${f}\``);
+				}
+				for (const f of it.filesModified ?? []) {
+					const url = repoUrl ? `${repoUrl}/blob/${it.hash}/${f}` : void 0;
+					lines.push(url ? `  - ✏️ [\`${f}\`](${url})` : `  - ✏️ \`${f}\``);
+				}
+				for (const f of it.filesDeleted ?? []) {
+					const url = repoUrl ? `${repoUrl}/commit/${it.hash}` : void 0;
+					lines.push(url ? `  - 🗑️ [~~\`${f}\`~~](${url})` : `  - 🗑️ ~~\`${f}\`~~`);
+				}
 			}
 			lines.push("");
 		}
@@ -342,9 +373,18 @@ function formatTimeline(items, repoUrl) {
 			lines.push(`- ${typeIcon} ${typeLabel} ${scopeFmt ? `${scopeFmt}: ` : ""}${it.description}`);
 			lines.push(`  > **🕒  ${time}** · \`➕${it.added}\` / \`➖${it.deleted}\``);
 			lines.push(`  > \`👤 ${it.author}\` ${email}${link}`);
-			for (const f of it.filesAdded ?? []) lines.push(`  - ➕ \`${f}\``);
-			for (const f of it.filesModified ?? []) lines.push(`  - ✏️ \`${f}\``);
-			for (const f of it.filesDeleted ?? []) lines.push(`  - 🗑️ ~~~~\`${f}\`~~~~`);
+			for (const f of it.filesAdded ?? []) {
+				const url = repoUrl ? `${repoUrl}/blob/${it.hash}/${f}` : void 0;
+				lines.push(url ? `  - ➕ [\`${f}\`](${url})` : `  - ➕ \`${f}\``);
+			}
+			for (const f of it.filesModified ?? []) {
+				const url = repoUrl ? `${repoUrl}/blob/${it.hash}/${f}` : void 0;
+				lines.push(url ? `  - ✏️ [\`${f}\`](${url})` : `  - ✏️ \`${f}\``);
+			}
+			for (const f of it.filesDeleted ?? []) {
+				const url = repoUrl ? `${repoUrl}/commit/${it.hash}` : void 0;
+				lines.push(url ? `  - 🗑️ [~~\`${f}\`~~](${url})` : `  - 🗑️ ~~\`${f}\`~~`);
+			}
 		}
 		lines.push("");
 	}
@@ -361,7 +401,7 @@ function formatTimeline(items, repoUrl) {
 */
 async function generateChangelogFiles(options) {
 	const repoRoot = await execCommand("git", ["rev-parse", "--show-toplevel"]);
-	const homepage = await readHomepage();
+	const homepage = await getRepoWebUrl();
 	const root = await getRootCommit();
 	const title = "全部历史";
 	const date = (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
@@ -405,6 +445,74 @@ async function cleanup(paths) {
 	await rimraf(paths, { glob: true });
 }
 
+//#endregion
+//#region src/commands/dir-tree.ts
+/**
+* 生成目录树结构字符串（ASCII Tree）
+* - 默认忽略常见目录：node_modules、.git、dist、out、logs
+* @param root 起始目录，默认为当前工作目录
+* @returns 目录树字符串
+*/
+async function buildDirTree(root = process.cwd(), ignoreList) {
+	const ignore = new Set(ignoreList ?? [
+		"node_modules",
+		".git",
+		"dist",
+		"out",
+		"logs"
+	]);
+	async function walk(dir, prefix = "") {
+		const items = (await readdir(dir, { withFileTypes: true })).filter((e) => !ignore.has(e.name)).map((e) => ({
+			name: e.name,
+			isDir: e.isDirectory()
+		})).sort((a, b) => a.isDir === b.isDir ? a.name.localeCompare(b.name) : a.isDir ? -1 : 1);
+		const lines = [];
+		const lastIdx = items.length - 1;
+		for (let i = 0; i < items.length; i++) {
+			const it = items[i];
+			const isLast = i === lastIdx;
+			const connector = isLast ? "└── " : "├── ";
+			const nextPrefix = prefix + (isLast ? "    " : "│   ");
+			lines.push(`${prefix}${connector}${it.name}`);
+			if (it.isDir) {
+				const sub = await walk(path.join(dir, it.name), nextPrefix);
+				lines.push(...sub);
+			}
+		}
+		return lines;
+	}
+	const title = path.basename(root);
+	const content = await walk(root);
+	return [`|-- ${title}`, ...content].join("\n");
+}
+/**
+* 根据目录树内容生成 Markdown 并写入文件
+* - 使用代码块包裹，便于阅读
+* @param tree 目录树字符串
+* @param outfile 输出文件路径，默认 `DIRECTORY_TREE.md`
+*/
+async function writeDirTreeMd(tree, outfile = "DIRECTORY_TREE.md") {
+	const md = `## 目录结构
+
+\`\`\`text\n${tree}\n\`\`\`\n`;
+	await writeFile(path.join(process.cwd(), outfile), md, "utf8");
+}
+/**
+* 生成并输出目录结构，支持可选生成 Markdown 文件
+* - 默认只在控制台输出
+* @param dir 目标目录，默认当前工作目录
+* @param md 是否生成 Markdown 文件，默认 false
+*/
+async function generateDirTree(dir, opts) {
+	const tree = await buildDirTree(dir ? path.resolve(process.cwd(), dir) : process.cwd(), opts?.ignore);
+	console.info("quiteer-script :>>", gray(`\n${tree}\n`));
+	if (opts?.md) {
+		const out = opts?.output || "DIRECTORY_TREE.md";
+		await writeDirTreeMd(tree, out);
+		console.info(lightCyan("quiteer-script :>>"), lightGreen(`已生成 Markdown: ${lightBlue(out)}`));
+	}
+}
+
 //#endregion
 //#region src/config/index.ts
 const defaultOptions = {
@@ -435,7 +543,18 @@ const defaultOptions = {
 		timelineOutput: "CHANGELOG_TIMELINE.md",
 		formats: "both"
 	},
-	gitCommit: { add: true }
+	gitCommit: { add: true },
+	dirTree: {
+		md: false,
+		output: "DIRECTORY_TREE.md",
+		ignore: [
+			"node_modules",
+			".git",
+			"dist",
+			"out",
+			"logs"
+		]
+	}
 };
 async function loadCliOptions(overrides, cwd = process.cwd()) {
 	const { config } = await loadConfig({
@@ -786,23 +905,34 @@ async function release(tagPrefix) {
 		`chore(projects): release ${tagName}`,
 		tagName
 	]);
+	const cli = await loadCliOptions();
+	const lang = cli.lang;
 	await generateChangelogFiles({
-		lang: "zh-cn",
-		format: "both",
-		groupOutput: "CHANGELOG.md",
-		timelineOutput: "CHANGELOG_TIMELINE.md"
+		lang,
+		format: cli.changelog.formats,
+		groupOutput: cli.changelog.groupOutput,
+		timelineOutput: cli.changelog.timelineOutput
 	});
 }
 
-//#endregion
-//#region src/commands/update-pkg.ts
-async function updatePkg(args = ["--deep", "-u"]) {
-	execCommand("npx", ["npm-check-updates", ...args], { stdio: "inherit" });
-}
-
 //#endregion
 //#region src/commands/self-update.ts
 /**
+* 获取当前命令来源路径（本地 node_modules/.bin 或全局）
+* @returns 可执行文件路径（若无法获取返回空字符串）
+*/
+async function getCurrentBinPath() {
+	try {
+		const p = await execCommand("command", ["-v", "qui"]);
+		if (p) return p;
+	} catch {}
+	try {
+		return await execCommand("which", ["qui"]);
+	} catch {
+		return "";
+	}
+}
+/**
 * 检查 @quiteer/scripts 是否有新版本并提示更新
 * - 启动任意命令时调用，仅提示不执行安装
 */
@@ -813,7 +943,12 @@ async function checkUpdateAndNotify() {
 			"@quiteer/scripts",
 			"version"
 		]);
-		if (latest && latest !== version) console.info("quiteer-script :>> ", lightCyan(`检测到新版本 ${lightGreen(latest)}，当前版本 ${lightBlue(version)}，建议执行 ${bgGreen(white("qui su"))} 进行更新`));
+		const binPath = await getCurrentBinPath();
+		const isLocal = binPath.includes("node_modules/.bin");
+		if (latest && latest !== version) {
+			console.info("quiteer-script :>> ", lightCyan(`检测到新版本 ${lightGreen(latest)}，当前版本 ${lightBlue(version)}，建议执行 ${bgGreen(white("qui su"))} 进行更新`));
+			if (isLocal) console.info("quiteer-script :>> ", lightBlue(`当前正在使用本地工作区命令：${binPath}`));
+		}
 	} catch {}
 }
 /**
@@ -842,11 +977,22 @@ async function selfUpdate() {
 			`@quiteer/scripts@${latest}`
 		], { stdio: "inherit" });
 		console.info("quiteer-script :>> ", lightGreen("更新完成，请重新运行命令"));
+		if ((await getCurrentBinPath()).includes("node_modules/.bin")) {
+			console.info("quiteer-script :>> ", lightBlue("当前命令来源于本地工作区，如需使用全局最新版本："));
+			console.info("quiteer-script :>> ", lightBlue("1) 退出当前仓库目录后执行 `qui`"));
+			console.info("quiteer-script :>> ", lightBlue("2) 或使用临时执行：`pnpm dlx @quiteer/scripts <command>`"));
+		}
 	} catch (e) {
 		console.info("quiteer-script :>> ", lightBlue(`更新失败：${e?.message || "未知错误"}`));
 	}
 }
 
+//#endregion
+//#region src/commands/update-pkg.ts
+async function updatePkg(args = ["--deep", "-u"]) {
+	execCommand("npx", ["npm-check-updates", ...args], { stdio: "inherit" });
+}
+
 //#endregion
 //#region src/index.ts
 async function setupCli() {
@@ -878,6 +1024,13 @@ async function setupCli() {
 	cli.command("self-update", `${bgGreen(white("便捷命令"))} ${lightCyan("qui su")}  自更新：检查并更新 @quiteer/scripts 到最新版本`).alias("su").action(async () => {
 		await selfUpdate();
 	});
+	cli.command("tree [path]", `${bgGreen(white("便捷命令"))} ${lightBlue("qui t")}  生成当前目录结构（默认控制台输出），可选生成 Markdown`).alias("t").option("--md", "是否生成 Markdown 文件", { default: cliOptions.dirTree.md }).action(async (path$1, args) => {
+		await generateDirTree(path$1, {
+			md: !!args?.md,
+			output: cliOptions.dirTree.output,
+			ignore: cliOptions.dirTree.ignore
+		});
+	});
 	cli.command("git-commit", `${bgGreen(white("便捷命令"))} ${lightBlue("qui gc")}  git 提交前后的操作和规范等`).alias("gc").option("--add", "添加所有变更文件到暂存区", { default: cliOptions.gitCommit.add }).option("-l ,--lang", "校验提交信息的语言", { default: cliOptions.lang }).action(async (args) => {
 		if (args?.add) await gitCommitAdd();
 		await gitCommit(args?.lang);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@quiteer/scripts",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "homepage": "https://taiaiac.github.io/web/ci/scripts.html",
   "publishConfig": {
     "access": "public",
@@ -49,6 +49,7 @@
   "scripts": {
     "dev": "tsdown -w",
     "build": "tsdown",
-    "release": "qui r --tag-prefix scripts"
+    "release": "qui r --tag-prefix scripts",
+    "build:release": "tsdown && pnpm publish"
   }
 }