@soybeanjs/changelog 0.4.0-beta.1 → 0.4.3

package/dist/index.d.ts

@@ -121,7 +121,7 @@ declare function getChangelogMarkdown(options?: Partial<ChangelogOption>, showTi
  * Get the changelog markdown by the total git tags
  *
  * @param options The changelog options
- * @param showProgress Whither show the progress bar
+ * @param showProgress Whether show the progress bar
  */
 declare function getTotalChangelogMarkdown(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<string>;
 /**

package/dist/index.js

@@ -11,8 +11,7 @@ import { convert } from "convert-gitmoji";
 //#region src/shared.ts
 async function execCommand(cmd, args, options) {
 	const { execa } = await import("execa");
-	const res = await execa(cmd, args, options);
-	return (res?.stdout)?.trim() || "";
+	return ((await execa(cmd, args, options))?.stdout)?.trim() || "";
 }
 function notNullish(v) {
 	return v !== null && v !== void 0;
@@ -60,14 +59,12 @@ const VERSION_WITH_RELEASE = /release\sv\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?/;
 //#region src/git.ts
 /** Get the total git tags */
 async function getTotalGitTags() {
-	const tagStr = await execCommand("git", [
+	const filtered = (await execCommand("git", [
 		"--no-pager",
 		"tag",
 		"-l",
 		"--sort=v:refname"
-	]);
-	const tags = tagStr.split("\n");
-	const filtered = tags.filter((tag) => VERSION_REG.test(tag));
+	])).split("\n").filter((tag) => VERSION_REG.test(tag));
 	return semver.sort(filtered);
 }
 /** Get map of the git tag and date */
@@ -81,8 +78,7 @@ async function getTagDateMap() {
 	]);
 	const TAG_MARK = "tag: ";
 	const map = /* @__PURE__ */ new Map();
-	const dates = tagDateStr.split("\n").filter((item) => item.includes(TAG_MARK));
-	dates.forEach((item) => {
+	tagDateStr.split("\n").filter((item) => item.includes(TAG_MARK)).forEach((item) => {
 		const [dateStr, tagStr] = item.split(TAG_MARK);
 		const date = dayjs(dateStr).format("YYYY-MM-DD");
 		const tag = tagStr.match(VERSION_REG)?.[0];
@@ -104,10 +100,7 @@ function getFromToTags(tags) {
 		if (index < reversedTags.length - 1) {
 			const to = tag;
 			let from = reversedTags[index + 1];
-			if (!isPrerelease(to)) {
-				const toIndex = releaseTags.indexOf(to);
-				from = releaseTags[toIndex - 1];
-			}
+			if (!isPrerelease(to)) from = releaseTags[releaseTags.indexOf(to) - 1];
 			result.push({
 				from,
 				to
@@ -117,12 +110,11 @@ function getFromToTags(tags) {
 	return result.reverse();
 }
 async function getGitMainBranchName() {
-	const main = await execCommand("git", [
+	return await execCommand("git", [
 		"rev-parse",
 		"--abbrev-ref",
 		"HEAD"
 	]);
-	return main;
 }
 async function getCurrentGitBranch() {
 	const tag = await execCommand("git", [
@@ -144,8 +136,7 @@ async function getGitHubRepo() {
 	return `${match[1]}/${match[2]}`;
 }
 function isPrerelease(version) {
-	const REG = /^[^.]*[\d.]+$/;
-	return !REG.test(version);
+	return !/^[^.]*[\d.]+$/.test(version);
 }
 function getFirstGitCommit() {
 	return execCommand("git", [
@@ -155,18 +146,16 @@ function getFirstGitCommit() {
 	]);
 }
 async function getGitDiff(from, to = "HEAD") {
-	const rawGit = await execCommand("git", [
+	return (await execCommand("git", [
 		"--no-pager",
 		"log",
 		`${from ? `${from}...` : ""}${to}`,
 		"--pretty=\"----%n%s|%h|%an|%ae%n%b\"",
 		"--name-status"
-	]);
-	const rwaGitLines = rawGit.split("----\n").splice(1);
-	const gitCommits = rwaGitLines.map((line) => {
+	])).split("----\n").splice(1).map((line) => {
 		const [firstLine, ...body] = line.split("\n");
 		const [message, shortHash, authorName, authorEmail] = firstLine.split("|");
-		const gitCommit = {
+		return {
 			message,
 			shortHash,
 			author: {
@@ -175,9 +164,7 @@ async function getGitDiff(from, to = "HEAD") {
 			},
 			body: body.join("\n")
 		};
-		return gitCommit;
 	});
-	return gitCommits;
 }
 function parseGitCommit(commit) {
 	const ConventionalCommitRegex = /(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i;
@@ -226,9 +213,7 @@ function parseGitCommit(commit) {
 	};
 }
 async function getGitCommits(from, to = "HEAD") {
-	const rwaGitCommits = await getGitDiff(from, to);
-	const commits = rwaGitCommits.map((commit) => parseGitCommit(commit)).filter(notNullish);
-	return commits;
+	return (await getGitDiff(from, to)).map((commit) => parseGitCommit(commit)).filter(notNullish);
 }
 function getHeaders(githubToken) {
 	return {
@@ -239,8 +224,7 @@ function getHeaders(githubToken) {
 async function getResolvedAuthorLogin(github, commitHashes, email) {
 	let login = "";
 	try {
-		const data = await ofetch(`https://ungh.cc/users/find/${email}`);
-		login = data?.user?.username || "";
+		login = (await ofetch(`https://ungh.cc/users/find/${email}`))?.user?.username || "";
 	} catch (e) {
 		consola.log("e: ", e);
 	}
@@ -248,15 +232,13 @@ async function getResolvedAuthorLogin(github, commitHashes, email) {
 	const { repo, token } = github;
 	if (!token) return login;
 	if (commitHashes.length) try {
-		const data = await ofetch(`https://api.github.com/repos/${repo}/commits/${commitHashes[0]}`, { headers: getHeaders(token) });
-		login = data?.author?.login || "";
+		login = (await ofetch(`https://api.github.com/repos/${repo}/commits/${commitHashes[0]}`, { headers: getHeaders(token) }))?.author?.login || "";
 	} catch (e) {
 		consola.log("e: ", e);
 	}
 	if (login) return login;
 	try {
-		const data = await ofetch(`https://api.github.com/search/users?q=${encodeURIComponent(email)}`, { headers: getHeaders(token) });
-		login = data.items[0].login;
+		login = (await ofetch(`https://api.github.com/search/users?q=${encodeURIComponent(email)}`, { headers: getHeaders(token) })).items[0].login;
 	} catch (e) {
 		consola.log("e: ", e);
 	}
@@ -282,10 +264,7 @@ async function getGitCommitsAndResolvedAuthors(commits, github, resolvedLogins)
 					const login = await getResolvedAuthorLogin(github, commitHashes, email);
 					resolvedAuthor.login = login;
 					resolvedLogins?.set(email, login);
-				} else {
-					const login = resolvedLogins?.get(email) || "";
-					resolvedAuthor.login = login;
-				}
+				} else resolvedAuthor.login = resolvedLogins?.get(email) || "";
 				resolvedAuthors.push(resolvedAuthor);
 				if (!map.has(email)) map.set(email, resolvedAuthor);
 			}
@@ -305,9 +284,8 @@ async function getGitCommitsAndResolvedAuthors(commits, github, resolvedLogins)
 //#endregion
 //#region src/options.ts
 function createDefaultOptions() {
-	const cwd = process.cwd();
-	const options = {
-		cwd,
+	return {
+		cwd: process.cwd(),
 		types: {
 			feat: "🚀 Features",
 			fix: "🐞 Bug Fixes",
@@ -337,14 +315,12 @@ function createDefaultOptions() {
 		output: "CHANGELOG.md",
 		regenerate: false
 	};
-	return options;
 }
 async function getVersionFromPkgJson(cwd) {
 	let newVersion = "";
 	try {
 		const pkgJson = await readFile(`${cwd}/package.json`, "utf-8");
-		const pkg = JSON.parse(pkgJson);
-		newVersion = pkg?.version || "";
+		newVersion = JSON.parse(pkgJson)?.version || "";
 	} catch {}
 	return { newVersion };
 }
@@ -375,15 +351,14 @@ async function createOptions(options) {
 //#endregion
 //#region src/markdown.ts
 function formatReferences(references, githubRepo, type) {
-	const refs = references.filter((i) => {
+	const referencesString = join(references.filter((i) => {
 		if (type === "issues") return i.type === "issue" || i.type === "pull-request";
 		return i.type === "hash";
 	}).map((ref) => {
 		if (!githubRepo) return ref.value;
 		if (ref.type === "pull-request" || ref.type === "issue") return `https://github.com/${githubRepo}/issues/${ref.value.slice(1)}`;
 		return `[<samp>(${ref.value.slice(0, 5)})</samp>](https://github.com/${githubRepo}/commit/${ref.value})`;
-	});
-	const referencesString = join(refs).trim();
+	})).trim();
 	if (type === "issues") return referencesString && `in ${referencesString}`;
 	return referencesString;
 }
@@ -398,8 +373,7 @@ function formatLine(commit, options) {
 		hashRefs
 	].filter((i) => i?.trim()).join(" ");
 	if (refs) refs = `&nbsp;-&nbsp; ${refs}`;
-	const description = options.capitalize ? capitalize(commit.description) : commit.description;
-	return [description, refs].filter((i) => i?.trim()).join(" ");
+	return [options.capitalize ? capitalize(commit.description) : commit.description, refs].filter((i) => i?.trim()).join(" ");
 }
 function formatTitle(name, options) {
 	const emojisRE = /([\u2700-\u27BF]|[\uE000-\uF8FF]|\uD83C[\uDC00-\uDFFF]|\uD83D[\uDC00-\uDFFF]|[\u2011-\u26FF]|\uD83E[\uDD10-\uDDFF])/g;
@@ -430,13 +404,10 @@ function formatSection(commits, sectionName, options) {
 	return lines;
 }
 function getUserGithub(userName) {
-	const githubUrl = `https://github.com/${userName}`;
-	return githubUrl;
+	return `https://github.com/${userName}`;
 }
 function getGitUserAvatar(userName) {
-	const githubUrl = getUserGithub(userName);
-	const avatarUrl = `${githubUrl}.png?size=48`;
-	return avatarUrl;
+	return `${getUserGithub(userName)}.png?size=48`;
 }
 function createContributorLine(contributors) {
 	let loginLine = "";
@@ -445,8 +416,7 @@ function createContributorLine(contributors) {
 	contributors.forEach((contributor) => {
 		contributorMap.set(contributor.email, contributor);
 	});
-	const filteredContributors = Array.from(contributorMap.values());
-	filteredContributors.forEach((contributor, index) => {
+	Array.from(contributorMap.values()).forEach((contributor, index) => {
 		const { name, email, login } = contributor;
 		if (!login) {
 			let line = `[${name}](mailto:${email})`;
@@ -460,11 +430,15 @@ function createContributorLine(contributors) {
 	});
 	return `${loginLine}\n${unLoginLine}`;
 }
-function generateMarkdown(params) {
+async function generateMarkdown(params) {
 	const { options, showTitle, contributors } = params;
 	const commits = params.commits.filter((commit) => commit.description.match(VERSION_WITH_RELEASE) === null);
 	const lines = [];
-	const url = `https://github.com/${options.github.repo}/compare/${options.from}...${options.to}`;
+	let url = `https://github.com/${options.github.repo}/compare/${options.from}...${options.to}`;
+	if (!options.from) {
+		const mainBranch = await getGitMainBranchName();
+		url = `https://github.com/${options.github.repo}/compare/${options.to}...${mainBranch || "HEAD"}`;
+	}
 	if (showTitle) {
 		const date = options.tagDateMap.get(options.to) || dayjs().format("YYYY-MM-DD");
 		let title = `## [${options.to}](${url})`;
@@ -485,8 +459,7 @@ function generateMarkdown(params) {
 		const contributorLine = createContributorLine(contributors);
 		lines.push(contributorLine);
 	}
-	const md = convert(lines.join("\n").trim(), true);
-	return md;
+	return convert(lines.join("\n").trim(), true);
 }
 async function isVersionInMarkdown(newVersion, mdPath) {
 	let isIn = false;
@@ -530,14 +503,13 @@ async function getChangelogMarkdown(options, showTitle = true) {
 	const gitCommits = await getGitCommits(opts.from, to);
 	const resolvedLogins = /* @__PURE__ */ new Map();
 	const { commits, contributors } = await getGitCommitsAndResolvedAuthors(gitCommits, opts.github, resolvedLogins);
-	const markdown = generateMarkdown({
-		commits,
-		options: opts,
-		showTitle,
-		contributors
-	});
 	return {
-		markdown,
+		markdown: await generateMarkdown({
+			commits,
+			options: opts,
+			showTitle,
+			contributors
+		}),
 		commits,
 		options: opts
 	};
@@ -546,7 +518,7 @@ async function getChangelogMarkdown(options, showTitle = true) {
 * Get the changelog markdown by the total git tags
 *
 * @param options The changelog options
-* @param showProgress Whither show the progress bar
+* @param showProgress Whether show the progress bar
 */
 async function getTotalChangelogMarkdown(options, showProgress = true) {
 	const opts = await createOptions(options);
@@ -562,9 +534,8 @@ async function getTotalChangelogMarkdown(options, showProgress = true) {
 	const resolvedLogins = /* @__PURE__ */ new Map();
 	for await (const [index, tag] of tags.entries()) {
 		const { from, to } = tag;
-		const gitCommits = await getGitCommits(from, to);
-		const { commits, contributors } = await getGitCommitsAndResolvedAuthors(gitCommits, opts.github, resolvedLogins);
-		const nextMd = generateMarkdown({
+		const { commits, contributors } = await getGitCommitsAndResolvedAuthors(await getGitCommits(from, to), opts.github, resolvedLogins);
+		markdown = `${await generateMarkdown({
 			commits,
 			options: {
 				...opts,
@@ -573,8 +544,7 @@ async function getTotalChangelogMarkdown(options, showProgress = true) {
 			},
 			showTitle: true,
 			contributors
-		});
-		markdown = `${nextMd}\n\n${markdown}`;
+		})}\n\n${markdown}`;
 		bar?.update(index + 1);
 	}
 	bar?.stop();
@@ -600,8 +570,7 @@ async function generateChangelog(options) {
 */
 async function generateTotalChangelog(options, showProgress = true) {
 	const opts = await createOptions(options);
-	const markdown = await getTotalChangelogMarkdown(opts, showProgress);
-	await writeMarkdown(markdown, opts.output, true);
+	await writeMarkdown(await getTotalChangelogMarkdown(opts, showProgress), opts.output, true);
 }
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@soybeanjs/changelog",
   "type": "module",
-  "version": "0.4.0-beta.1",
+  "version": "0.4.3",
   "description": "generate changelog form git tags and commits for github",
   "author": {
     "name": "Soybean",
@@ -38,25 +38,25 @@
     "pnpm": ">=9"
   },
   "dependencies": {
-    "@soybeanjs/eslint-config": "1.7.1",
+    "@soybeanjs/eslint-config": "1.7.5",
     "cli-progress": "3.12.0",
     "convert-gitmoji": "0.1.5",
-    "dayjs": "1.11.15",
-    "execa": "9.6.0",
-    "ofetch": "1.4.1",
-    "semver": "7.7.2"
+    "dayjs": "1.11.19",
+    "execa": "9.6.1",
+    "ofetch": "1.5.1",
+    "semver": "7.7.3"
   },
   "devDependencies": {
-    "@soybeanjs/cli": "1.4.0",
+    "@soybeanjs/cli": "1.4.1",
     "@types/cli-progress": "3.11.6",
-    "@types/node": "24.3.0",
-    "@types/semver": "7.7.0",
-    "eslint": "9.34.0",
-    "lint-staged": "16.1.5",
+    "@types/node": "25.0.3",
+    "@types/semver": "7.7.1",
+    "eslint": "9.39.2",
+    "lint-staged": "16.2.7",
     "simple-git-hooks": "2.13.1",
-    "tsdown": "0.14.2",
-    "tsx": "4.20.5",
-    "typescript": "5.9.2"
+    "tsdown": "0.18.2",
+    "tsx": "4.21.0",
+    "typescript": "5.9.3"
   },
   "simple-git-hooks": {
     "commit-msg": "pnpm soy git-commit-verify",