@pubinfo/commitlint 2.0.13 → 2.0.14

package/dist/index.js

@@ -1,3 +1,3 @@
-import { a as configureGitHooksPath, c as createGitMessage, d as runCzConfig, f as isCommitlintEnabled, i as runPrompt, l as runGitMessage, m as loadCommitConfig, n as lintMessage, o as runNpx, p as commitPreset, r as isInsideGitRepo, s as runSimpleGitHooks, t as lintAndReturn, u as createCzConfig } from "./lint.message-DVvlpU1w.js";
+import { a as configureGitHooksPath, c as createGitMessage, d as runCzConfig, f as isCommitlintEnabled, i as runPrompt, l as runGitMessage, m as loadCommitConfig, n as lintMessage, o as runNpx, p as commitPreset, r as isInsideGitRepo, s as runSimpleGitHooks, t as lintAndReturn, u as createCzConfig } from "./lint.message-Cdip9x5S.js";
 
 export { commitPreset, configureGitHooksPath, createCzConfig, createGitMessage, isCommitlintEnabled, isInsideGitRepo, lintAndReturn, lintMessage, loadCommitConfig, runCzConfig, runGitMessage, runNpx, runPrompt, runSimpleGitHooks };

package/dist/lint.message-Cdip9x5S.js

@@ -0,0 +1,467 @@
+import { createRequire } from "node:module";
+import { execSync, spawn } from "node:child_process";
+import { loadConfig } from "unconfig";
+import { join, resolve } from "node:path";
+import process from "node:process";
+import CZGPackage from "czg/package.json" with { type: "json" };
+import fs from "fs-extra";
+import fs$1 from "node:fs";
+
+//#region src/config/index.ts
+const notWip = [
+	"main",
+	"master",
+	"dev",
+	"test",
+	"release"
+];
+function isMainBranch() {
+	try {
+		try {
+			const currentBranch = execSync("git branch --show-current", { encoding: "utf8" }).trim();
+			if (currentBranch) return notWip.includes(currentBranch);
+		} catch {
+			try {
+				const currentBranch = execSync("git symbolic-ref --short HEAD", { encoding: "utf8" }).trim();
+				return notWip.includes(currentBranch);
+			} catch {
+				return false;
+			}
+		}
+	} catch {
+		return false;
+	}
+	return false;
+}
+function generateCommitTypes() {
+	const allTypes = [
+		"feat",
+		"fix",
+		"docs",
+		"style",
+		"refactor",
+		"perf",
+		"test",
+		"build",
+		"ci",
+		"chore",
+		"revert",
+		"types",
+		"release",
+		"init",
+		"wip"
+	];
+	if (isMainBranch()) return allTypes.filter((type) => type !== "wip");
+	return allTypes;
+}
+function generateCzGitTypes() {
+	const all = [
+		{
+			value: "feat",
+			name: "feat:     ✨  新功能",
+			emoji: ":sparkles:"
+		},
+		{
+			value: "fix",
+			name: "fix:      🐛  修复缺陷",
+			emoji: ":bug:"
+		},
+		{
+			value: "types",
+			name: "types:    🎨  类型相关",
+			emoji: ":art:"
+		},
+		{
+			value: "docs",
+			name: "docs:     📝  文档更新",
+			emoji: ":memo:"
+		},
+		{
+			value: "style",
+			name: "style:    💄  代码格式",
+			emoji: ":lipstick:"
+		},
+		{
+			value: "refactor",
+			name: "refactor: ♻️   代码重构",
+			emoji: ":recycle:"
+		},
+		{
+			value: "perf",
+			name: "perf:     ⚡️  性能提升",
+			emoji: ":zap:"
+		},
+		{
+			value: "test",
+			name: "test:     ✅  测试相关",
+			emoji: ":white_check_mark:"
+		},
+		{
+			value: "build",
+			name: "build:    📦️  构建相关",
+			emoji: ":package:"
+		},
+		{
+			value: "release",
+			name: "release:  🔖  版本提升",
+			emoji: ":bookmark:"
+		},
+		{
+			value: "ci",
+			name: "ci:       🎡  持续集成",
+			emoji: ":ferris_wheel:"
+		},
+		{
+			value: "revert",
+			name: "revert:   ⏪️  回退代码",
+			emoji: ":rewind:"
+		},
+		{
+			value: "chore",
+			name: "chore:    🔨  其他修改",
+			emoji: ":hammer:"
+		},
+		{
+			value: "init",
+			name: "init:     🎉  初始化",
+			emoji: ":tada:"
+		},
+		{
+			value: "wip",
+			name: "wip:      🚧  工作进行中",
+			emoji: ":construction:"
+		}
+	];
+	if (isMainBranch()) return all.filter((t) => t.value !== "wip");
+	return all;
+}
+const commitPreset = {
+	extends: ["@commitlint/config-conventional"],
+	rules: {
+		"scope-enum": [0],
+		"type-enum": [
+			2,
+			"always",
+			generateCommitTypes()
+		],
+		"type-empty": [2, "never"],
+		"type-case": [
+			2,
+			"always",
+			"lower-case"
+		],
+		"subject-empty": [2, "never"],
+		"subject-full-stop": [
+			2,
+			"never",
+			"."
+		],
+		"subject-case": [
+			2,
+			"never",
+			[
+				"sentence-case",
+				"start-case",
+				"pascal-case",
+				"upper-case"
+			]
+		],
+		"header-max-length": [
+			2,
+			"always",
+			100
+		],
+		"body-leading-blank": [1, "always"],
+		"footer-leading-blank": [1, "always"]
+	},
+	prompt: {
+		alias: { fd: "docs: fix typos" },
+		messages: {
+			scope: "选择一个提交范围 (可回车跳过):",
+			customScope: "请输入自定义的提交范围 :",
+			type: "选择你要提交的类型 :",
+			subject: "填写简短精炼的变更描述 :\n",
+			body: "填写更加详细的变更描述（可选）。使用 \"|\" 换行 :\n",
+			breaking: "列举非兼容性重大的变更（可选）。使用 \"|\" 换行 :\n",
+			footerPrefixsSelect: "选择关联issue前缀（可选）:",
+			customFooterPrefixs: "输入自定义issue前缀 :",
+			footer: "列举关联issue (可选) 例如: #31, #I3244 :\n",
+			confirmCommit: "是否提交或修改commit ?"
+		},
+		types: generateCzGitTypes(),
+		useEmoji: false,
+		emojiAlign: "center",
+		themeColorCode: "",
+		enableMultipleScopes: true,
+		skipQuestions: ["scope"],
+		defaultScope: "___CUSTOM___:",
+		customScopesAlign: "bottom",
+		customScopesAlias: "custom",
+		emptyScopesAlias: "empty",
+		upperCaseSubject: false,
+		markBreakingChangeMode: true,
+		allowBreakingChanges: ["feat", "fix"],
+		breaklineNumber: 100,
+		breaklineChar: "|",
+		issuePrefixs: [{
+			value: "link",
+			name: "link:     链接 ISSUES 进行中"
+		}, {
+			value: "closed",
+			name: "closed:   标记 ISSUES 已完成"
+		}],
+		customIssuePrefixsAlign: "top",
+		emptyIssuePrefixsAlias: "skip",
+		customIssuePrefixsAlias: "custom",
+		allowCustomIssuePrefixs: true,
+		allowEmptyIssuePrefixs: true,
+		confirmColorize: true,
+		maxHeaderLength: Number.POSITIVE_INFINITY,
+		maxSubjectLength: Number.POSITIVE_INFINITY,
+		minSubjectLength: 0,
+		scopeOverrides: void 0,
+		defaultBody: "",
+		defaultIssues: "",
+		defaultSubject: ""
+	}
+};
+function loadCommitConfig() {
+	return commitPreset;
+}
+
+//#endregion
+//#region src/config/commitlint.ts
+let cachedState;
+function resolveCommitlintEnabled(value) {
+	if (typeof value === "boolean") return value;
+	if (value && typeof value === "object") {
+		if (typeof value.enabled === "boolean") return value.enabled;
+		if (typeof value.disable === "boolean") return !value.disable;
+	}
+}
+async function isCommitlintEnabled() {
+	if (typeof cachedState === "boolean") return cachedState;
+	try {
+		const resolved = resolveCommitlintEnabled((await loadConfig({
+			sources: [{ files: "pubinfo.config" }],
+			merge: false
+		}))?.config?.commitlint);
+		cachedState = typeof resolved === "boolean" ? resolved : true;
+	} catch {
+		cachedState = true;
+	}
+	return cachedState;
+}
+
+//#endregion
+//#region src/init/cz.config.ts
+function createCzConfig(cwd = process.cwd()) {
+	const target = resolve(cwd, "cz.config.cjs");
+	if (fs.existsSync(target)) fs.unlinkSync(target);
+	try {
+		const cfg = {
+			$schema: `https://raw.githubusercontent.com/Zhengqbbb/cz-git/refs/tags/v${CZGPackage.version}/docs/public/schema/cz-git.json`,
+			...commitPreset.prompt,
+			types: commitPreset.prompt?.types?.map((t) => ({
+				value: t.value,
+				name: t.name,
+				emoji: t.emoji
+			})),
+			scopes: commitPreset.prompt?.scopes
+		};
+		const content = `module.exports = ${JSON.stringify(cfg, null, 2)}\n`;
+		fs.writeFileSync(target, content, "utf8");
+		return true;
+	} catch {
+		return false;
+	}
+}
+function runCzConfig(czConfigPath, cwd = process.cwd()) {
+	const packagePath = resolve(cwd, "package.json");
+	if (!fs.existsSync(packagePath)) return false;
+	try {
+		const raw = fs.readFileSync(packagePath, "utf8");
+		const json = JSON.parse(raw);
+		const desiredPath = "node_modules/cz-git";
+		const desiredCzConfig = czConfigPath;
+		json.config = json.config || {};
+		json.config.commitizen = json.config.commitizen || {};
+		let changed = false;
+		if (json.config.commitizen.path !== desiredPath) {
+			json.config.commitizen.path = desiredPath;
+			changed = true;
+		}
+		const currentCz = json.config.commitizen.czConfig;
+		const normalize = (p) => p ? p.replace(/^\.\/?/, "") : p;
+		const isOldRoot = normalize(currentCz) === "cz.config.cjs" || normalize(currentCz) === "cz.config.js";
+		if (!currentCz || isOldRoot || normalize(currentCz) === "cz.config.mjs") {
+			if (currentCz !== desiredCzConfig) {
+				json.config.commitizen.czConfig = desiredCzConfig;
+				changed = true;
+			}
+		}
+		if (!changed) return false;
+		fs.writeFileSync(packagePath, `${JSON.stringify(json, null, 2)}\n`, "utf8");
+		return true;
+	} catch {
+		return false;
+	}
+}
+
+//#endregion
+//#region src/init/git.message.ts
+function createGitMessage(rootPath = process.cwd()) {
+	const target = resolve(rootPath, ".gitmessage");
+	if (fs.existsSync(target)) fs.unlinkSync(target);
+	const tpl = `# Commit Message 模板 (首行: <type>(<scope>): <subject>)\n# 可用类型: ${(commitPreset.prompt?.types || []).map((t) => t.value).join(", ")}\n# 可用范围: ${(commitPreset.prompt?.scopes || []).join(", ")}\n# 示例: feat(core): add http client abstraction\n# 空行后可写入 body, 使用 | 换行 (交互模式会自动处理)\n`;
+	fs.writeFileSync(target, tpl, "utf8");
+	return true;
+}
+function runGitMessage(rootPath = process.cwd()) {
+	try {
+		if (execSync("git config --get commit.template", {
+			cwd: rootPath,
+			stdio: "pipe"
+		}).toString().trim()) return false;
+	} catch {}
+	try {
+		execSync("git config commit.template .gitmessage", {
+			cwd: rootPath,
+			stdio: "ignore"
+		});
+		return true;
+	} catch {
+		return false;
+	}
+}
+
+//#endregion
+//#region src/init/simple.git.hook.ts
+function runSimpleGitHooks(script = "pubinfo-commit", cwd = process.cwd(), enabled = true) {
+	if (!enabled) return false;
+	const pkgPath = resolve(cwd, "package.json");
+	if (!fs.existsSync(pkgPath)) return false;
+	try {
+		const raw = fs.readFileSync(pkgPath, "utf8");
+		const json = JSON.parse(raw);
+		const hooks = json["simple-git-hooks"] || {};
+		const desiredPre = "pnpm lint-staged";
+		const desiredCommitMsg = `pnpm exec ${script} --edit $1`;
+		json["simple-git-hooks"] = hooks;
+		if (hooks["pre-commit"] !== desiredPre) hooks["pre-commit"] = desiredPre;
+		if (hooks["commit-msg"] !== desiredCommitMsg) hooks["commit-msg"] = desiredCommitMsg;
+		json["simple-git-hooks"] = hooks;
+		fs.writeFileSync(pkgPath, `${JSON.stringify(json, null, 2)}\n`, "utf8");
+		return true;
+	} catch {
+		return false;
+	}
+}
+function runNpx(cwd = process.cwd()) {
+	try {
+		execSync("npx simple-git-hooks", {
+			cwd,
+			stdio: "ignore"
+		});
+		return true;
+	} catch {
+		return false;
+	}
+}
+function configureGitHooksPath(enabled = true, cwd = process.cwd()) {
+	try {
+		if (enabled) {
+			execSync("git config --unset core.hooksPath", {
+				cwd,
+				stdio: "ignore"
+			});
+			return true;
+		}
+		execSync("git config core.hooksPath /dev/null", {
+			cwd,
+			stdio: "ignore"
+		});
+		return true;
+	} catch {
+		return enabled;
+	}
+}
+
+//#endregion
+//#region src/prompt/index.ts
+async function runPrompt() {
+	try {
+		const require = createRequire(import.meta.url);
+		try {
+			const czg = require("czg");
+			if (czg && typeof czg.default === "function") {
+				const api = await czg.default({ emoji: false });
+				if (api && api.raw) return { raw: api.raw };
+			}
+		} catch {}
+		const binDir = resolve(process.cwd(), "node_modules/.bin");
+		const isWin = process.platform === "win32";
+		const czgBin = (isWin ? [
+			join(binDir, "czg.cmd"),
+			join(binDir, "czg.ps1"),
+			join(binDir, "czg")
+		] : [join(binDir, "czg")]).find((p) => fs$1.existsSync(p));
+		if (czgBin) {
+			await new Promise((res) => {
+				const child = spawn(czgBin, [], {
+					stdio: "inherit",
+					shell: isWin
+				});
+				child.on("exit", () => res());
+				child.on("error", () => res());
+			});
+			const msgPath = resolve(process.cwd(), ".git/COMMIT_EDITMSG");
+			if (fs$1.existsSync(msgPath)) return { raw: fs$1.readFileSync(msgPath, "utf8").trim() };
+		}
+		return null;
+	} catch {
+		return null;
+	}
+}
+
+//#endregion
+//#region src/utils/git.ts
+/**
+* 判断当前工作目录是否处在 Git 仓库内。
+*/
+function isInsideGitRepo() {
+	try {
+		const out = execSync("git rev-parse --is-inside-work-tree", { stdio: [
+			"ignore",
+			"pipe",
+			"ignore"
+		] });
+		return String(out).trim() === "true";
+	} catch {
+		return false;
+	}
+}
+
+//#endregion
+//#region src/utils/lint.message.ts
+async function lintMessage(message) {
+	if (!await isCommitlintEnabled()) return true;
+	try {
+		const result = await (await import("@commitlint/lint")).default(message, commitPreset.rules, commitPreset);
+		if (!result.valid) {
+			console.error("✖ Commit message failed lint:\n");
+			for (const err of result.errors) console.error(`  • ${err.message}`);
+			process.exit(1);
+		}
+	} catch (e) {
+		console.error("[pubinfo-commit] lint failed to run:", e);
+	}
+	return true;
+}
+async function lintAndReturn(message) {
+	await lintMessage(message);
+	return message;
+}
+
+//#endregion
+export { configureGitHooksPath as a, createGitMessage as c, runCzConfig as d, isCommitlintEnabled as f, runPrompt as i, runGitMessage as l, loadCommitConfig as m, lintMessage as n, runNpx as o, commitPreset as p, isInsideGitRepo as r, runSimpleGitHooks as s, lintAndReturn as t, createCzConfig as u };

package/dist/run.js

@@ -1,11 +1,11 @@
-import { a as configureGitHooksPath, c as createGitMessage, d as runCzConfig, f as isCommitlintEnabled, i as runPrompt, l as runGitMessage, n as lintMessage, o as runNpx, r as isInsideGitRepo, s as runSimpleGitHooks, u as createCzConfig } from "./lint.message-DVvlpU1w.js";
+import { a as configureGitHooksPath, c as createGitMessage, d as runCzConfig, f as isCommitlintEnabled, i as runPrompt, l as runGitMessage, n as lintMessage, o as runNpx, r as isInsideGitRepo, s as runSimpleGitHooks, u as createCzConfig } from "./lint.message-Cdip9x5S.js";
 import process from "node:process";
 import fs from "node:fs";
 import { defineCommand, runMain as runMain$1 } from "citty";
 
 //#region package.json
 var name = "@pubinfo/commitlint";
-var version = "2.0.13";
+var version = "2.0.14";
 var description = "commitlint config for Pubinfo projects";
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pubinfo/commitlint",
   "type": "module",
-  "version": "2.0.13",
+  "version": "2.0.14",
   "description": "commitlint config for Pubinfo projects",
   "exports": {
     ".": "./dist/index.js"
@@ -33,7 +33,8 @@
     "@commitlint/load": "^19.8.1",
     "citty": "^0.1.6",
     "czg": "^1.12.0",
-    "unconfig": "^7.3.2"
+    "fs-extra": "^11.3.0",
+    "unconfig": "^7.3.3"
   },
   "scripts": {
     "build": "tsdown",