keepchanges 0.0.1 → 0.0.3

package/README.md

@@ -98,10 +98,24 @@ npx keepchanges 1.1.0 --release --dry
 ### 生成和发布行为
 
 仓库地址优先读取 `package.json#repository`，不存在时读取 Git 的 `origin`。
-当前支持 GitHub。识别到仓库后，每条记录会包含 commit 链接，末尾会包含版本对比链接。
+GitHub 地址会被自动识别。自托管 Gitea 需要在 `package.json` 中显式声明：
+
+```json
+{
+  "repository": {
+    "type": "git",
+    "provider": "gitea",
+    "url": "http://10.102.248.21/edram/keepchanges.git"
+  }
+}
+```
+
+识别到仓库后，每条记录会包含 commit 和 PR 链接，末尾会包含版本对比链接。
+GitHub 和 Gitea 均支持作者解析和 Release 发布；Gitea 使用 `GITEA_TOKEN`
+解析 commit 主作者并发布 Release。
 
 默认使用 Git 提交中的作者名，并将 `Co-Authored-By` 参与者一起写入记录，bot
-账号会被忽略。提供 token 后，会通过 GitHub 尝试将邮箱解析为用户名。
+账号会被忽略。提供对应平台的 token 后，会尝试将邮箱解析为用户名。
 
 `--commit` 只提交 changelog 和检测到的版本文件。其他已暂存或未暂存的改动会
 保持原状。
@@ -223,13 +237,27 @@ npx keepchanges 1.1.0 --release --dry
 ### Generation and release behavior
 
 The repository URL is read from `package.json#repository`, then from the Git
-`origin`. GitHub is currently supported. When a repository is detected, each
-entry includes a commit link and the release ends with a version comparison
-link.
+`origin`. GitHub URLs are detected automatically. A self-hosted Gitea repository
+must be declared explicitly in `package.json`:
+
+```json
+{
+  "repository": {
+    "type": "git",
+    "provider": "gitea",
+    "url": "http://10.102.248.21/edram/keepchanges.git"
+  }
+}
+```
+
+When a repository is detected, entries include commit and pull request links,
+and the release ends with a version comparison link. GitHub and Gitea both
+support author resolution and Release publishing. Gitea uses `GITEA_TOKEN` to
+resolve primary commit authors and publish Releases.
 
 Entries use Git author names by default and include `Co-Authored-By`
-participants. Bot accounts are omitted. With a token, the CLI asks GitHub to
-resolve email addresses to usernames.
+participants. Bot accounts are omitted. With the corresponding provider token,
+the CLI attempts to resolve email addresses to usernames.
 
 `--commit` commits only the changelog and detected version file. Other staged
 and unstaged changes remain untouched.

package/dist/cli.mjs

@@ -9,7 +9,7 @@ import { readFile, writeFile } from "node:fs/promises";
 import { normalizeFull } from "verkit";
 import { x } from "tinyexec";
 //#region package.json
-var version = "0.0.1";
+var version = "0.0.3";
 //#endregion
 //#region src/changelog.ts
 function createChangelog(version, commits, repository, comparisonFrom) {
@@ -17,6 +17,7 @@ function createChangelog(version, commits, repository, comparisonFrom) {
 		...renderSection(commits.filter((commit) => commit.isBreaking), "🚨 Breaking Changes", repository),
 		...renderSection(commits.filter((commit) => !commit.isBreaking && commit.type === "feat"), "🚀 Features", repository),
 		...renderSection(commits.filter((commit) => !commit.isBreaking && commit.type === "fix"), "🐞 Bug Fixes", repository),
+		...renderSection(commits.filter((commit) => !commit.isBreaking && commit.type === "perf"), "🏎 Performance", repository),
 		...repository && comparisonFrom ? ["", `#####     [View changes on ${repository.provider.name}](${repository.provider.compareUrl(repository, comparisonFrom, `v${version}`)})`] : []
 	].join("\n").trim();
 	return {
@@ -58,7 +59,7 @@ function insertRelease(changelog, release) {
 	return `${preamble}\n\n${release.trim()}\n\n${history}\n`;
 }
 function releaseHeadings(changelog) {
-	return [...changelog.matchAll(/^##\s+(\S+).*$/gm)].flatMap((heading) => {
+	return [...changelog.matchAll(/^##[^\S\r\n]+(\S+)/gm)].flatMap((heading) => {
 		const version = normalizeFull(heading[1]);
 		return version ? [{
 			index: heading.index,
@@ -67,21 +68,40 @@ function releaseHeadings(changelog) {
 	});
 }
 function renderSection(commits, title, repository) {
-	const lines = commits.map((commit) => {
-		const scope = commit.scope ? `**${escapeHtml(commit.scope)}**: ` : "";
+	const renderedCommits = commits.map((commit) => {
 		const reference = repository ? `[<samp>(${commit.hash.slice(0, 5)})</samp>](${repository.provider.commitUrl(repository, commit.hash)})` : "";
 		const authorNames = commit.authors.map((author) => author.login ? `@${author.login}` : `**${escapeHtml(author.name)}**`);
 		const authors = authorNames.length > 1 ? `${authorNames.slice(0, -1).join(", ")} and ${authorNames.at(-1)}` : authorNames[0] || "";
-		const details = [authors ? `by ${authors}` : "", reference].filter(Boolean).join(" ");
+		const pullRequests = commit.pullRequests.map((pullRequest) => repository ? `[${pullRequest}](${repository.provider.pullRequestUrl(repository, pullRequest)})` : pullRequest).join(", ");
+		const details = [
+			authors ? `by ${authors}` : "",
+			pullRequests ? `in ${pullRequests}` : "",
+			reference
+		].filter(Boolean).join(" ");
 		const suffix = details ? ` &nbsp;-&nbsp; ${details}` : "";
-		return `${scope}${escapeHtml(capitalize$1(commit.description))}${suffix}`;
-	}).reverse();
-	if (!lines.length) return [];
+		return {
+			scope: commit.scope,
+			line: `${escapeHtml(capitalize$1(commit.description))}${suffix}`
+		};
+	});
+	if (!renderedCommits.length) return [];
+	const commitsByScope = /* @__PURE__ */ new Map();
+	for (const { scope, line } of renderedCommits) {
+		const lines = commitsByScope.get(scope) || [];
+		lines.push(line);
+		commitsByScope.set(scope, lines);
+	}
+	const lines = [...commitsByScope].some(([scope, lines]) => Boolean(scope) && lines.length > 1) ? [...commitsByScope.keys()].sort().flatMap((scope) => {
+		const scopedLines = (commitsByScope.get(scope) || []).reverse().map((line) => `${scope ? "  " : ""}- ${line}`);
+		return scope ? [`- **${escapeHtml(scope)}**:`, ...scopedLines] : scopedLines;
+	}) : renderedCommits.reverse().map(({ scope, line }) => {
+		return `- ${scope ? `**${escapeHtml(scope)}**: ` : ""}${line}`;
+	});
 	return [
 		"",
 		`### ${title}`,
 		"",
-		...lines.map((line) => `- ${line}`)
+		...lines
 	];
 }
 function capitalize$1(value) {
@@ -148,8 +168,10 @@ function parseGitLog(log) {
 function parseCommit(hash, subject, body, author) {
 	const match = /^(?<type>[a-z]+)(?:\((?<scope>[^()\r\n]+)\))?(?<breaking>!)?: (?<description>.+)$/i.exec(subject);
 	if (!match?.groups) return null;
+	const pullRequestPattern = /\([ a-z]*(#\d+)\s*\)/gi;
+	const pullRequests = [...new Set([...match.groups.description.matchAll(pullRequestPattern)].map((reference) => reference[1]))];
 	const authors = [author];
-	for (const coAuthor of body.matchAll(/^Co-Authored-By:\s*(.+?)\s*<([^>]+)>$/gim)) {
+	for (const coAuthor of body.matchAll(/^Co-Authored-By:([^<\r\n]+)<([^>\r\n]+)>[^\S\r\n]*$/gim)) {
 		const email = coAuthor[2].trim();
 		if (!authors.some((author) => author.email === email)) authors.push({
 			name: coAuthor[1].trim(),
@@ -161,11 +183,91 @@ function parseCommit(hash, subject, body, author) {
 		authors: authors.filter((author) => !/\[bot\]|dependabot|\(bot\)/i.test(author.name)),
 		type: match.groups.type.toLowerCase(),
 		scope: match.groups.scope || "",
-		description: match.groups.description,
+		description: match.groups.description.replace(pullRequestPattern, "").trim(),
+		pullRequests,
 		isBreaking: Boolean(match.groups.breaking) || /^BREAKING(?: |-)CHANGE:/im.test(body)
 	};
 }
 //#endregion
+//#region src/providers/gitea.ts
+const giteaProvider = {
+	name: "Gitea",
+	parse(source) {
+		try {
+			const url = new URL(source.replace(/^git\+/, ""));
+			if (!/^https?:$/.test(url.protocol)) return;
+			const path = url.pathname.replace(/^\/+|\/+$/g, "").replace(/\.git$/, "");
+			if (!path.includes("/")) return;
+			return {
+				provider: giteaProvider,
+				path,
+				webUrl: `${url.origin}/${path}`
+			};
+		} catch {}
+	},
+	token(explicit, env) {
+		return explicit || env.GITEA_TOKEN;
+	},
+	commitUrl(repository, hash) {
+		return `${repository.webUrl}/commit/${hash}`;
+	},
+	pullRequestUrl(repository, reference) {
+		return `${repository.webUrl}/pulls/${reference.replace(/^#/, "")}`;
+	},
+	compareUrl(repository, from, to) {
+		return `${repository.webUrl}/compare/${from}...${to}`;
+	},
+	async resolveAuthors(commits, repository, token, fetch) {
+		const headers = {
+			accept: "application/json",
+			authorization: `token ${token}`
+		};
+		const commitsByEmail = new Map(commits.flatMap((commit) => commit.authors[0] ? [[commit.authors[0].email, commit]] : []));
+		const loginsByEmail = /* @__PURE__ */ new Map();
+		await Promise.all([...commitsByEmail].map(async ([email, commit]) => {
+			try {
+				const response = await fetch(`${new URL(repository.webUrl).origin}/api/v1/repos/${repository.path}/git/commits/${commit.hash}`, { headers });
+				if (!response.ok) return;
+				const data = await response.json();
+				if (data.author?.login) loginsByEmail.set(email, data.author.login);
+			} catch {}
+		}));
+		for (const commit of commits) for (const author of commit.authors) author.login = loginsByEmail.get(author.email);
+	},
+	async publishRelease(repository, release, token, fetch) {
+		const headers = {
+			"accept": "application/json",
+			"authorization": `token ${token}`,
+			"content-type": "application/json"
+		};
+		const releasesUrl = `${new URL(repository.webUrl).origin}/api/v1/repos/${repository.path}/releases`;
+		const existing = await fetch(`${releasesUrl}/tags/${encodeURIComponent(release.tag)}`, { headers });
+		let url = releasesUrl;
+		let method = "POST";
+		let action = "created";
+		if (existing.ok) {
+			url = `${releasesUrl}/${(await existing.json()).id}`;
+			method = "PATCH";
+			action = "updated";
+		} else if (existing.status !== 404) throw new Error(`Gitea release lookup failed (${existing.status})`);
+		const response = await fetch(url, {
+			method,
+			headers,
+			body: JSON.stringify({
+				tag_name: release.tag,
+				name: release.name,
+				body: release.body,
+				prerelease: release.prerelease
+			})
+		});
+		if (!response.ok) throw new Error(`Gitea release publishing failed (${response.status})`);
+		return {
+			url: (await response.json()).html_url,
+			action
+		};
+	}
+};
+//#endregion
 //#region src/providers/github.ts
 const githubProvider = {
 	name: "GitHub",
@@ -184,6 +286,9 @@ const githubProvider = {
 	commitUrl(repository, hash) {
 		return `${repository.webUrl}/commit/${hash}`;
 	},
+	pullRequestUrl(repository, reference) {
+		return `${repository.webUrl}/pull/${reference.replace(/^#/, "")}`;
+	},
 	compareUrl(repository, from, to) {
 		return `${repository.webUrl}/compare/${from}...${to}`;
 	},
@@ -214,8 +319,8 @@ const githubProvider = {
 	},
 	async publishRelease(repository, release, token, fetch) {
 		const headers = {
-			accept: "application/vnd.github+json",
-			authorization: `Bearer ${token}`,
+			"accept": "application/vnd.github+json",
+			"authorization": `Bearer ${token}`,
 			"content-type": "application/json"
 		};
 		const releasesUrl = `https://api.github.com/repos/${repository.path}/releases`;
@@ -247,10 +352,15 @@ const githubProvider = {
 };
 //#endregion
 //#region src/repository.ts
-const providers$1 = [githubProvider];
+const providers$1 = {
+	gitea: giteaProvider,
+	github: githubProvider
+};
 async function resolveRepository(cwd) {
+	let providerName = "";
 	let source = await readFile(resolve(cwd, "package.json"), "utf8").then((contents) => {
 		const repository = JSON.parse(contents).repository;
+		if (typeof repository === "object") providerName = repository?.provider?.toLowerCase() || "";
 		return typeof repository === "string" ? repository : repository?.url || "";
 	}).catch(() => "");
 	if (!source) source = (await x("git", [
@@ -258,7 +368,8 @@ async function resolveRepository(cwd) {
 		"get-url",
 		"origin"
 	], { nodeOptions: { cwd } })).stdout.trim();
-	for (const provider of providers$1) {
+	if (providerName) return providers$1[providerName]?.parse(source);
+	for (const provider of [githubProvider]) {
 		const repository = provider.parse(source);
 		if (repository) return repository;
 	}
@@ -364,7 +475,7 @@ async function runChangelog(options, environment) {
 			printReleasePreview();
 			stdout(`${colors.yellow("Dry run. Release skipped.")}\n\n`);
 			printManualReleaseUrl();
-		} else stdout(changelog);
+		} else stdout(release);
 		return;
 	}
 	if (options.release && taggedCommit) {
@@ -393,7 +504,7 @@ function capitalize(value) {
 	return value.charAt(0).toUpperCase() + value.slice(1);
 }
 function resolveGitIdentity(author = defaultAuthor) {
-	const match = /^(.+?)\s*<([^<>]+)>$/.exec(author);
+	const match = /^([^<>\r\n]+)<([^<>\r\n]+)>$/.exec(author);
 	if (!match) throw new Error("Author must use the \"Name <email>\" format");
 	return [
 		"-c",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "keepchanges",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Generate and maintain CHANGELOG.md from Conventional Commits.",
   "author": "edram",
   "license": "MIT",
@@ -13,42 +13,46 @@
   "bugs": {
     "url": "https://github.com/edram/keepchanges/issues"
   },
-  "bin": {
-    "changelog": "./dist/cli.mjs"
-  },
+  "keywords": [
+    "changelog",
+    "cli",
+    "conventional-commits",
+    "git"
+  ],
   "exports": {
     ".": "./dist/cli.mjs",
     "./cli": "./dist/cli.mjs",
     "./package.json": "./package.json"
   },
+  "bin": {
+    "changelog": "./dist/cli.mjs"
+  },
   "files": [
     "dist"
   ],
   "engines": {
     "node": ">=20.19.0"
   },
-  "keywords": [
-    "changelog",
-    "cli",
-    "conventional-commits",
-    "git"
-  ],
+  "dependencies": {
+    "ansis": "^4.3.1",
+    "cac": "^7.0.0",
+    "tinyexec": "^1.2.4",
+    "verkit": "^0.3.0"
+  },
   "devDependencies": {
+    "@antfu/eslint-config": "^9.2.0",
     "@types/node": "^26.1.1",
     "bumpp": "^11.1.0",
+    "eslint": "^10.7.0",
     "tsdown": "^0.22.5",
     "typescript": "^6.0.3",
     "vitest": "^4.1.10"
   },
-  "dependencies": {
-    "ansis": "^4.3.1",
-    "cac": "^7.0.0",
-    "tinyexec": "^1.2.4",
-    "verkit": "^0.3.0"
-  },
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown --watch",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "test": "pnpm run build && vitest run",
     "typecheck": "tsc --noEmit",
     "release": "bumpp"