@quiteer/scripts 0.0.11 → 0.1.0

package/README.md

@@ -1,6 +1,6 @@
 # @quiteer/scripts
 > 简化多包仓库的版本管理与变更日志生成，提供便捷的 CLI 命令。
-> [文档](https://quiteerjs.github.io/web/ci/scripts.html)
+> [文档](https://quiteerjs.github.io/web/cli/scripts.html)
 
 ## 安装
 

package/dist/index.mjs

@@ -12,7 +12,7 @@ import enquirer from "enquirer";
 import { versionBump } from "bumpp";
 
 //#region package.json
-var version = "0.0.11";
+var version = "0.1.0";
 
 //#endregion
 //#region src/locales/changelog.ts
@@ -550,14 +550,14 @@ const defaultOptions = {
 	}
 };
 async function loadCliOptions(overrides, cwd = process.cwd()) {
-	const { config } = await loadConfig({
+	const { config: config$1 } = await loadConfig({
 		name: "quiteer",
 		defaults: defaultOptions,
 		overrides,
 		cwd,
 		packageJson: true
 	});
-	return config;
+	return config$1;
 }
 
 //#endregion
@@ -906,6 +906,13 @@ async function release(tagPrefix) {
 		groupOutput: cli.changelog.groupOutput,
 		timelineOutput: cli.changelog.timelineOutput
 	});
+	await execCommand("git", [
+		"-C",
+		repoRoot,
+		"add",
+		"-A"
+	]);
+	await gitCommit(lang);
 }
 
 //#endregion
@@ -986,6 +993,151 @@ async function updatePkg(args = ["--deep", "-u"]) {
 	execCommand("npx", ["npm-check-updates", ...args], { stdio: "inherit" });
 }
 
+//#endregion
+//#region src/customize/git-commit.ts
+/**
+* 解析分支名获取版本号
+*
+* 从分支名中提取版本号部分并添加 'v' 前缀。例如将 'dev-1.2.3.4-patch' 转换为 'v1.2.3.4-patch'。
+* 这样符合 Conventional Commits 的 scope 规范，同时也满足特定的版本管理需求。
+*
+* @param branch - Git 分支名称
+* @returns 格式化后的版本号字符串，如果不匹配 'dev-' 前缀则返回原分支名
+*
+* @example
+* ```ts
+* parseBranchToVersion('dev-1.2.3.4-patch') // 返回 'v1.2.3.4-patch'
+* parseBranchToVersion('feat-login') // 返回 'feat-login'
+* ```
+*/
+function parseBranchToVersion(branch) {
+	if (!branch) return "";
+	const match = branch.match(/^dev-(\d+\.\d+\.\d+\.\d+(?:-[a-z0-9]+)?)$/);
+	if (match && match[1]) return `v${match[1]}`;
+	return branch;
+}
+/**
+* 获取当前 Git 分支名称
+*
+* 使用 git symbolic-ref 获取当前分支的短名称
+*
+* @returns {Promise<string>} 分支名称，获取失败返回空字符串
+*/
+async function getBranchName() {
+	try {
+		return (await execCommand("git", [
+			"symbolic-ref",
+			"--short",
+			"HEAD"
+		])).trim();
+	} catch {
+		return "";
+	}
+}
+const config = {
+	gitCommitMessages: {
+		types: "请选择提交类型",
+		scopes: "请输入当前分支信息或者按下 [Tab] 键自动填充",
+		description: `请输入描述信息（${yellow("!")}开头表示破坏性改动`
+	},
+	gitCommitTypes: [
+		["feat", "新功能"],
+		["feat-wip", "开发中的功能，比如某功能的部分代码"],
+		["fix", "修复Bug"],
+		["docs", "只涉及文档更新"],
+		["typo", "代码或文档勘误，比如错误拼写"],
+		["style", "修改代码风格，不影响代码含义的变更"],
+		["refactor", "代码重构，既不修复 bug 也不添加功能的代码变更"],
+		["perf", "可提高性能的代码更改"],
+		["optimize", "优化代码质量的代码更改"],
+		["test", "添加缺失的测试或更正现有测试"],
+		["build", "影响构建系统或外部依赖项的更改"],
+		["ci", "对 CI 配置文件和脚本的更改"],
+		["chore", "没有修改src或测试文件的其他变更"],
+		["revert", "还原先前的提交"]
+	]
+};
+/**
+* 交互式生成符合 Conventional Commits 的提交信息并执行提交 (天泽智联定制版)
+* - 提交范围 (scope) 默认为当前 Git 分支名称
+* - 支持取消或非交互环境下安全退出
+* @param {Lang} lang 交互提示语言
+* @returns {Promise<void>} 异步任务
+*/
+async function gitCommitTz() {
+	try {
+		const { prompt: ask } = enquirer;
+		const { gitCommitMessages, gitCommitTypes } = config;
+		const initialScope = parseBranchToVersion(await getBranchName());
+		const typesChoices = gitCommitTypes.map(([value, msg]) => {
+			return {
+				name: value,
+				message: `${`${value}:`.padEnd(12)}${msg}`
+			};
+		});
+		const result = await ask([
+			{
+				name: "types",
+				type: "select",
+				message: gitCommitMessages.types,
+				choices: typesChoices
+			},
+			{
+				name: "scopes",
+				type: "input",
+				message: gitCommitMessages.scopes,
+				initial: initialScope,
+				validate(value) {
+					if (!value.trim()) return "分支信息 (scope) 不能为空";
+					return true;
+				}
+			},
+			{
+				name: "description",
+				type: "input",
+				message: gitCommitMessages.description,
+				initial: "输入本次提交的描述信息",
+				validate(value) {
+					if (!value.trim() || value === "输入本次提交的描述信息") return "提交描述不能为空";
+					if (value.length < 2) return "提交描述长度不能少于 2 个字符";
+					return true;
+				}
+			}
+		]);
+		if (!result) return;
+		const breaking = result.description.startsWith("!") ? "!" : "";
+		const description = result.description.replace(/^!/, "").trim();
+		await execCommand("git", [
+			"commit",
+			"-m",
+			`${result.types}(${result.scopes})${breaking}: ${description}`
+		], { stdio: "inherit" });
+	} catch {}
+}
+
+//#endregion
+//#region src/customize/git-commit-verify.ts
+/** Git commit message verify */
+async function gitCommitVerifyTz(lang = "zh-cn", ignores = []) {
+	const gitPath = await execCommand("git", ["rev-parse", "--show-toplevel"]);
+	const commitMsg = readFileSync(path.join(gitPath, ".git", "COMMIT_EDITMSG"), "utf8").trim();
+	if (ignores.some((regExp) => regExp.test(commitMsg))) return;
+	const REG_EXP = /^(?<type>[a-z-]+)(?:\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)$/i;
+	const VERSION_REG_EXP = /^v\d+\.\d+\.\d+\.\d+(-[a-z0-9]+)?$/;
+	const match = commitMsg.match(REG_EXP);
+	if (!match) {
+		const errorMsg = locales[lang].gitCommitVerify;
+		throw new Error(errorMsg);
+	}
+	const { type, scope } = match.groups || {};
+	if (type === "fix") {
+		if (!scope || !VERSION_REG_EXP.test(scope)) {
+			const errorMsg = lang === "zh-cn" ? `[校验失败]: 当提交类型为 'fix' 时，scope 必须是符合规范的版本号 (例如: v1.2.3.4 或 v1.2.3.4-patch)` : `[Verify Failed]: When commit type is 'fix', scope must be a valid version (e.g., v1.2.3.4 or v1.2.3.4-patch)`;
+			throw new Error(errorMsg);
+		}
+	}
+}
+
 //#endregion
 //#region src/index.ts
 async function setupCli() {
@@ -1046,6 +1198,13 @@ async function setupCli() {
 			timelineOutput: args.timelineOutput || cfg.timelineOutput
 		});
 	});
+	cli.command("git-commit-tianze", `${bgGreen(white("便捷命令"))} ${lightBlue("qui gz")}   天泽智联的 git 提交前后的操作和规范等`).alias("gz").option("--add", "添加所有变更文件到暂存区", { default: cliOptions.gitCommit.add }).action(async (args) => {
+		if (args?.add) await gitCommitAdd();
+		await gitCommitTz();
+	});
+	cli.command("git-commit-verify-tianze", `${bgGreen(white("便捷命令"))} ${lightBlue("qui gzv")}  天泽智联的 git commit 校验提交信息是否符合标准`).alias("gzv").action(async () => {
+		await gitCommitVerifyTz();
+	});
 	cli.version(lightGreen(version)).help().parse();
 }
 setupCli();

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@quiteer/scripts",
   "type": "module",
-  "version": "0.0.11",
-  "homepage": "https://quiteerjs.github.io/web/ci/scripts.html",
+  "version": "0.1.0",
+  "homepage": "https://quiteerjs.github.io/web/cli/scripts.html",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -49,6 +49,6 @@
   "scripts": {
     "dev": "tsdown -w",
     "build": "tsdown",
-    "release": "qui r --tag-prefix scripts && qui gc && tsdown && pnpm publish"
+    "release": "qui r --tag-prefix scripts && tsdown && pnpm publish"
   }
 }