@soybeanjs/changelog 0.0.1

package/README.md

@@ -0,0 +1,32 @@
+# @soybeanjs/changelog
+
+generate changelog by git tags and commits
+
+## Install
+
+```bash
+pnpm i -D @soybeanjs/changelog
+```
+
+## Usage
+
+```ts
+import {
+  getChangelogMarkdown,
+  getTotalChangelogMarkdown,
+  generateChangelog,
+  generateTotalChangelog,
+} from "@soybeanjs/changelog";
+
+// get the changelog markdown by two git tags
+getChangelogMarkdown();
+
+// get the changelog markdown by the total git tags
+getTotalChangelogMarkdown();
+
+// generate the changelog markdown by two git tags
+generateChangelog();
+
+// generate the changelog markdown by the total git tags
+generateTotalChangelog();
+```

package/dist/index.cjs

@@ -0,0 +1,560 @@
+'use strict';
+
+const cliProgress = require('cli-progress');
+const promises = require('fs/promises');
+const ofetch = require('ofetch');
+const dayjs = require('dayjs');
+const fs = require('fs');
+const convertGitmoji = require('convert-gitmoji');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const cliProgress__default = /*#__PURE__*/_interopDefaultCompat(cliProgress);
+const dayjs__default = /*#__PURE__*/_interopDefaultCompat(dayjs);
+
+async function execCommand(cmd, args, options) {
+  const { execa } = await import('execa');
+  const res = await execa(cmd, args, options);
+  return res?.stdout?.trim() || "";
+}
+function notNullish(v) {
+  return v !== null && v !== void 0;
+}
+function partition(array, ...filters) {
+  const result = new Array(filters.length + 1).fill(null).map(() => []);
+  array.forEach((e, idx, arr) => {
+    let i = 0;
+    for (const filter of filters) {
+      if (filter(e, idx, arr)) {
+        result[i].push(e);
+        return;
+      }
+      i += 1;
+    }
+    result[i].push(e);
+  });
+  return result;
+}
+function groupBy(items, key, groups = {}) {
+  for (const item of items) {
+    const v = item[key];
+    groups[v] = groups[v] || [];
+    groups[v].push(item);
+  }
+  return groups;
+}
+function capitalize(str) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+function join(array, glue = ", ", finalGlue = " and ") {
+  if (!array || array.length === 0)
+    return "";
+  if (array.length === 1)
+    return array[0];
+  if (array.length === 2)
+    return array.join(finalGlue);
+  return `${array.slice(0, -1).join(glue)}${finalGlue}${array.slice(-1)}`;
+}
+
+const VERSION_REG = /v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?/;
+const VERSION_REG_OF_MARKDOWN = /## \[v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?]/g;
+
+async function getTotalGitTags() {
+  const tagStr = await execCommand("git", ["--no-pager", "tag", "-l", "--sort=creatordate"]);
+  const tags = tagStr.split("\n");
+  return tags;
+}
+async function getTagDateMap() {
+  const tagDateStr = await execCommand("git", [
+    "--no-pager",
+    "log",
+    "--tags",
+    "--simplify-by-decoration",
+    "--pretty=format:%ci %d"
+  ]);
+  const TAG_MARK = "tag: ";
+  const map = /* @__PURE__ */ new Map();
+  const dates = tagDateStr.split("\n").filter((item) => item.includes(TAG_MARK));
+  dates.forEach((item) => {
+    const [dateStr, tagStr] = item.split(TAG_MARK);
+    const date = dayjs__default(dateStr).format("YYYY-MM-DD");
+    const tag = tagStr.match(VERSION_REG)?.[0];
+    if (tag && date) {
+      map.set(tag.trim(), date);
+    }
+  });
+  return map;
+}
+function getFromToTags(tags) {
+  const result = [];
+  tags.forEach((tag, index) => {
+    if (index < tags.length - 1) {
+      result.push({ from: tag, to: tags[index + 1] });
+    }
+  });
+  return result;
+}
+async function getLastGitTag(delta = 0) {
+  const tags = await getTotalGitTags();
+  return tags[tags.length + delta - 1];
+}
+async function getGitMainBranchName() {
+  const main = await execCommand("git", ["rev-parse", "--abbrev-ref", "HEAD"]);
+  return main;
+}
+async function getCurrentGitBranch() {
+  const tag = await execCommand("git", ["tag", "--points-at", "HEAD"]);
+  const main = getGitMainBranchName();
+  return tag || main;
+}
+async function getGitHubRepo() {
+  const url = await execCommand("git", ["config", "--get", "remote.origin.url"]);
+  const match = url.match(/github\.com[/:]([\w\d._-]+?)\/([\w\d._-]+?)(\.git)?$/i);
+  if (!match) {
+    throw new Error(`Can not parse GitHub repo from url ${url}`);
+  }
+  return `${match[1]}/${match[2]}`;
+}
+function getFirstGitCommit() {
+  return execCommand("git", ["rev-list", "--max-parents=0", "HEAD"]);
+}
+async function getGitDiff(from, to = "HEAD") {
+  const rawGit = 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) => {
+    const [firstLine, ...body] = line.split("\n");
+    const [message, shortHash, authorName, authorEmail] = firstLine.split("|");
+    const gitCommmit = {
+      message,
+      shortHash,
+      author: { name: authorName, email: authorEmail },
+      body: body.join("\n")
+    };
+    return gitCommmit;
+  });
+  return gitCommits;
+}
+function parseGitCommit(commit) {
+  const ConventionalCommitRegex = /(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i;
+  const CoAuthoredByRegex = /co-authored-by:\s*(?<name>.+)(<(?<email>.+)>)/gim;
+  const PullRequestRE = /\([a-z]*(#\d+)\s*\)/gm;
+  const IssueRE = /(#\d+)/gm;
+  const match = commit.message.match(ConventionalCommitRegex);
+  if (!match?.groups) {
+    return null;
+  }
+  const type = match.groups.type;
+  const scope = match.groups.scope || "";
+  const isBreaking = Boolean(match.groups.breaking);
+  let description = match.groups.description;
+  const references = [];
+  for (const m of description.matchAll(PullRequestRE)) {
+    references.push({ type: "pull-request", value: m[1] });
+  }
+  for (const m of description.matchAll(IssueRE)) {
+    if (!references.some((i) => i.value === m[1])) {
+      references.push({ type: "issue", value: m[1] });
+    }
+  }
+  references.push({ value: commit.shortHash, type: "hash" });
+  description = description.replace(PullRequestRE, "").trim();
+  const authors = [commit.author];
+  const matchs = commit.body.matchAll(CoAuthoredByRegex);
+  for (const $match of matchs) {
+    const { name = "", email = "" } = $match.groups || {};
+    const author = {
+      name: name.trim(),
+      email: email.trim()
+    };
+    authors.push(author);
+  }
+  return {
+    ...commit,
+    authors,
+    resolvedAuthors: [],
+    description,
+    type,
+    scope,
+    references,
+    isBreaking
+  };
+}
+async function getGitCommits(from, to = "HEAD") {
+  const rwaGitCommits = await getGitDiff(from, to);
+  const commits = rwaGitCommits.map((commit) => parseGitCommit(commit)).filter(notNullish);
+  return commits;
+}
+function getHeaders(githubToken) {
+  return {
+    accept: "application/vnd.github.v3+json",
+    authorization: `token ${githubToken}`
+  };
+}
+async function getResolvedAuthorLogin(github, commitHashes, email) {
+  let login = "";
+  try {
+    const data = await ofetch.ofetch(`https://ungh.cc/users/find/${email}`);
+    login = data?.user?.username || "";
+  } catch {
+  }
+  if (login) {
+    return login;
+  }
+  const { repo, token } = github;
+  if (!token) {
+    return login;
+  }
+  if (commitHashes.length) {
+    try {
+      const data = await ofetch.ofetch(`https://api.github.com/repos/${repo}/commits/${commitHashes[0]}`, {
+        headers: getHeaders(token)
+      });
+      login = data?.author?.login || "";
+    } catch (e) {
+    }
+  }
+  if (login) {
+    return login;
+  }
+  try {
+    const data = await ofetch.ofetch(`https://api.github.com/search/users?q=${encodeURIComponent(email)}`, {
+      headers: getHeaders(token)
+    });
+    login = data.items[0].login;
+  } catch (e) {
+  }
+  return login;
+}
+async function getGitCommitsAndResolvedAuthors(commits, github, resolvedLogins) {
+  const resultCommits = [];
+  const map = /* @__PURE__ */ new Map();
+  for await (const commit of commits) {
+    const resolvedAuthors = [];
+    for await (const [index, author] of Object.entries(commit.authors)) {
+      const { email, name } = author;
+      if (email && name) {
+        const commitHashes = [];
+        if (index === "0") {
+          commitHashes.push(commit.shortHash);
+        }
+        const resolvedAuthor = {
+          name,
+          email,
+          commits: commitHashes,
+          login: ""
+        };
+        if (!resolvedLogins?.has(email)) {
+          const login = await getResolvedAuthorLogin(github, commitHashes, email);
+          resolvedAuthor.login = login;
+          resolvedLogins?.set(email, login);
+        } else {
+          const login = resolvedLogins?.get(email) || "";
+          resolvedAuthor.login = login;
+        }
+        resolvedAuthors.push(resolvedAuthor);
+        if (!map.has(email)) {
+          map.set(email, resolvedAuthor);
+        }
+      }
+    }
+    const resultCommit = { ...commit, resolvedAuthors };
+    resultCommits.push(resultCommit);
+  }
+  return {
+    commits: resultCommits,
+    contributors: Array.from(map.values())
+  };
+}
+
+function createDefaultOptions() {
+  const cwd = process.cwd();
+  const options = {
+    cwd,
+    types: {
+      feat: "\u{1F680} Features",
+      fix: "\u{1F41E} Bug Fixes",
+      perf: "\u{1F525} Performance",
+      refactor: "\u{1F485} Refactors",
+      docs: "\u{1F4D6} Documentation",
+      build: "\u{1F4E6} Build",
+      types: "\u{1F30A} Types",
+      chore: "\u{1F3E1} Chore",
+      examples: "\u{1F3C0} Examples",
+      test: "\u2705 Tests",
+      style: "\u{1F3A8} Styles",
+      ci: "\u{1F916} CI"
+    },
+    github: {
+      repo: "",
+      token: process.env.GITHUB_TOKEN || ""
+    },
+    from: "",
+    to: "",
+    tags: [],
+    tagDateMap: /* @__PURE__ */ new Map(),
+    capitalize: true,
+    emoji: true,
+    titles: {
+      breakingChanges: "\u{1F6A8} Breaking Changes"
+    },
+    output: "CHANGELOG.md",
+    regenerate: false,
+    newVersion: ""
+  };
+  return options;
+}
+async function getVersionFromPkgJson(cwd) {
+  let newVersion = "";
+  try {
+    const pkgJson = await promises.readFile(`${cwd}/package.json`, "utf-8");
+    const pkg = JSON.parse(pkgJson);
+    newVersion = pkg?.version || "";
+  } catch {
+  }
+  return {
+    newVersion
+  };
+}
+async function createOptions(options) {
+  var _a;
+  const opts = createDefaultOptions();
+  Object.assign(opts, options);
+  const { newVersion } = await getVersionFromPkgJson(opts.cwd);
+  (_a = opts.github).repo || (_a.repo = await getGitHubRepo());
+  opts.newVersion || (opts.newVersion = `v${newVersion}`);
+  opts.from || (opts.from = await getLastGitTag());
+  opts.to || (opts.to = await getCurrentGitBranch());
+  if (opts.to === opts.from) {
+    const lastTag = await getLastGitTag(-1);
+    const firstCommit = await getFirstGitCommit();
+    opts.from = lastTag || firstCommit;
+  }
+  opts.tags = await getTotalGitTags();
+  opts.tagDateMap = await getTagDateMap();
+  return opts;
+}
+
+function formatReferences(references, githubRepo, type) {
+  const refs = 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();
+  if (type === "issues")
+    return referencesString && `in ${referencesString}`;
+  return referencesString;
+}
+function formatLine(commit, options) {
+  const prRefs = formatReferences(commit.references, options.github.repo, "issues");
+  const hashRefs = formatReferences(commit.references, options.github.repo, "hash");
+  let authors = join([...new Set(commit.resolvedAuthors.map((i) => i.login ? `@${i.login}` : `**${i.name}**`))]).trim();
+  if (authors) {
+    authors = `by ${authors}`;
+  }
+  let refs = [authors, prRefs, 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(" ");
+}
+function formatTitle(name, options) {
+  const emojisRE = /([\u2700-\u27BF]|[\uE000-\uF8FF]|\uD83C[\uDC00-\uDFFF]|\uD83D[\uDC00-\uDFFF]|[\u2011-\u26FF]|\uD83E[\uDD10-\uDDFF])/g;
+  let formatName = name.trim();
+  if (!options.emoji) {
+    formatName = name.replace(emojisRE, "").trim();
+  }
+  return `### &nbsp;&nbsp;&nbsp;${formatName}`;
+}
+function formatSection(commits, sectionName, options) {
+  if (!commits.length)
+    return [];
+  const lines = ["", formatTitle(sectionName, options), ""];
+  const scopes = groupBy(commits, "scope");
+  let useScopeGroup = true;
+  if (!Object.entries(scopes).some(([k, v]) => k && v.length > 1)) {
+    useScopeGroup = false;
+  }
+  Object.keys(scopes).sort().forEach((scope) => {
+    let padding = "";
+    let prefix = "";
+    const scopeText = `**${scope}**`;
+    if (scope && useScopeGroup) {
+      lines.push(`- ${scopeText}:`);
+      padding = "  ";
+    } else if (scope) {
+      prefix = `${scopeText}: `;
+    }
+    lines.push(...scopes[scope].reverse().map((commit) => `${padding}- ${prefix}${formatLine(commit, options)}`));
+  });
+  return lines;
+}
+function getUserGithub(userName) {
+  const githubUrl = `https://github.com/${userName}`;
+  return githubUrl;
+}
+function getGitUserAvatar(userName) {
+  const githubUrl = getUserGithub(userName);
+  const avatarUrl = `${githubUrl}.png?size=48`;
+  return avatarUrl;
+}
+function createContributorLine(contributors) {
+  let loginLine = "";
+  let unloginLine = "";
+  contributors.forEach((contributor, index) => {
+    const { name, email, login } = contributor;
+    if (!login) {
+      let line = `[${name}](mailto:${email})`;
+      if (index < contributors.length - 1) {
+        line += ",&nbsp;";
+      }
+      unloginLine += line;
+    } else {
+      const githubUrl = getUserGithub(login);
+      const avatar = getGitUserAvatar(login);
+      loginLine += `[![${login}](${avatar})](${githubUrl})&nbsp;&nbsp;`;
+    }
+  });
+  return `${loginLine}
+${unloginLine}`;
+}
+function generateMarkdown(params) {
+  const { commits, options, showTitle, contributors } = params;
+  const lines = [];
+  const url = `https://github.com/${options.github.repo}/compare/${options.from}...${options.to}`;
+  if (showTitle) {
+    const isNewVersion = !VERSION_REG.test(options.to);
+    const version = isNewVersion ? options.newVersion : options.to;
+    const date = isNewVersion ? dayjs__default().format("YY-MM-DD") : options.tagDateMap.get(options.to);
+    let title = `## [${version}](${url})`;
+    if (date) {
+      title += ` (${date})`;
+    }
+    lines.push(title);
+  }
+  const [breaking, changes] = partition(commits, (c) => c.isBreaking);
+  const group = groupBy(changes, "type");
+  lines.push(...formatSection(breaking, options.titles.breakingChanges, options));
+  for (const type of Object.keys(options.types)) {
+    const items = group[type] || [];
+    lines.push(...formatSection(items, options.types[type], options));
+  }
+  if (!lines.length) {
+    lines.push("*No significant changes*");
+  }
+  if (!showTitle) {
+    lines.push("", `##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](${url})`);
+  }
+  if (showTitle) {
+    lines.push("", "### &nbsp;&nbsp;&nbsp;\u2764\uFE0F Contributors", "");
+    const contributorLine = createContributorLine(contributors);
+    lines.push(contributorLine);
+  }
+  const md = convertGitmoji.convert(lines.join("\n").trim(), true);
+  return md;
+}
+async function isVersionInMarkdown(version, mdPath) {
+  let isIn = false;
+  const md = await promises.readFile(mdPath, "utf8");
+  if (md) {
+    const matches = md.match(VERSION_REG_OF_MARKDOWN);
+    if (matches?.length) {
+      const versionInMarkdown = `## [${version}]`;
+      isIn = matches.includes(versionInMarkdown);
+    }
+  }
+  return isIn;
+}
+async function writeMarkdown(md, mdPath, regenerate = false) {
+  let changelogMD;
+  const changelogPrefix = "# Changelog";
+  if (!regenerate && fs.existsSync(mdPath)) {
+    changelogMD = await promises.readFile(mdPath, "utf8");
+    if (!changelogMD.startsWith(changelogPrefix)) {
+      changelogMD = `${changelogPrefix}
+
+${changelogMD}`;
+    }
+  } else {
+    changelogMD = `${changelogPrefix}
+
+`;
+  }
+  const lastEntry = changelogMD.match(/^###?\s+.*$/m);
+  if (lastEntry) {
+    changelogMD = `${changelogMD.slice(0, lastEntry.index) + md}
+
+${changelogMD.slice(lastEntry.index)}`;
+  } else {
+    changelogMD += `
+${md}
+
+`;
+  }
+  await promises.writeFile(mdPath, changelogMD);
+}
+
+async function getChangelogMarkdown(options) {
+  const opts = await createOptions(options);
+  const gitCommits = await getGitCommits(opts.from, opts.to);
+  const { commits, contributors } = await getGitCommitsAndResolvedAuthors(gitCommits, opts.github);
+  const markdown = generateMarkdown({ commits, options: opts, showTitle: true, contributors });
+  return markdown;
+}
+async function getTotalChangelogMarkdown(options, showProgress = true) {
+  const opts = await createOptions(options);
+  let bar = null;
+  if (showProgress) {
+    bar = new cliProgress__default.SingleBar(
+      { format: "generate total changelog: [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}" },
+      cliProgress__default.Presets.shades_classic
+    );
+  }
+  const tags = getFromToTags(opts.tags);
+  bar?.start(tags.length, 0);
+  let markdown = "";
+  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({ commits, options: { ...opts, from, to }, showTitle: true, contributors });
+    markdown = `${nextMd}
+
+${markdown}`;
+    bar?.update(index + 1);
+  }
+  bar?.stop();
+  return markdown;
+}
+async function generateChangelog(options) {
+  const opts = await createOptions(options);
+  const existContent = await isVersionInMarkdown(opts.to, opts.output);
+  if (!opts.regenerate && existContent)
+    return;
+  const markdown = await getChangelogMarkdown(opts);
+  await writeMarkdown(markdown, opts.output, opts.regenerate);
+}
+async function generateTotalChangelog(options, showProgress = true) {
+  const opts = await createOptions(options);
+  const markdown = await getTotalChangelogMarkdown(opts, showProgress);
+  await writeMarkdown(markdown, opts.output, true);
+}
+
+exports.generateChangelog = generateChangelog;
+exports.generateTotalChangelog = generateTotalChangelog;
+exports.getChangelogMarkdown = getChangelogMarkdown;
+exports.getTotalChangelogMarkdown = getTotalChangelogMarkdown;

package/dist/index.d.ts

@@ -0,0 +1,102 @@
+/**
+ * github config
+ */
+interface GithubConfig {
+    /**
+     * the github repository name
+     * @example soybeanjs/changelog
+     */
+    repo: string;
+    /**
+     * the github token
+     */
+    token: string;
+}
+interface ChangelogOption {
+    /**
+     * the directory of the project
+     * @default process.cwd()
+     */
+    cwd: string;
+    /**
+     * the commit scope types
+     */
+    types: Record<string, string>;
+    /**
+     * github config
+     */
+    github: GithubConfig;
+    /**
+     * the commit hash or tag
+     */
+    from: string;
+    /**
+     * the commit hash or tag
+     */
+    to: string;
+    /**
+     * the whole commit tags
+     */
+    tags: string[];
+    /**
+     * the commit tag and date map
+     */
+    tagDateMap: Map<string, string>;
+    /**
+     * Whether to capitalize the first letter of the commit type
+     */
+    capitalize: boolean;
+    /**
+     * Use emojis in section titles
+     * @default true
+     */
+    emoji: boolean;
+    /**
+     * the section titles
+     */
+    titles: {
+        /**
+         * the title of breaking changes section
+         */
+        breakingChanges: string;
+    };
+    /**
+     * the output file path of the changelog
+     */
+    output: string;
+    /**
+     * Whether to regenerate the changelog if it already exists
+     * @example the changelog already exists the content of v0.0.1, but you want to regenerate it
+     */
+    regenerate: boolean;
+    /**
+     * version from package.json, with preffix "v"
+     * @description if the options "to" is not specified, the version will be used
+     */
+    newVersion: string;
+}
+
+/**
+ * get the changelog markdown by two git tags
+ * @param options the changelog options
+ */
+declare function getChangelogMarkdown(options?: Partial<ChangelogOption>): Promise<string>;
+/**
+ * get the changelog markdown by the total git tags
+ * @param options the changelog options
+ * @param showProgress whither show the progress bar
+ */
+declare function getTotalChangelogMarkdown(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<string>;
+/**
+ * generate the changelog markdown by two git tags
+ * @param options the changelog options
+ */
+declare function generateChangelog(options?: Partial<ChangelogOption>): Promise<void>;
+/**
+ * generate the changelog markdown by the total git tags
+ * @param options the changelog options
+ * @param showProgress whither show the progress bar
+ */
+declare function generateTotalChangelog(options?: Partial<ChangelogOption>, showProgress?: boolean): Promise<void>;
+
+export { ChangelogOption, generateChangelog, generateTotalChangelog, getChangelogMarkdown, getTotalChangelogMarkdown };

package/dist/index.mjs

@@ -0,0 +1,550 @@
+import cliProgress from 'cli-progress';
+import { readFile, writeFile } from 'fs/promises';
+import { ofetch } from 'ofetch';
+import dayjs from 'dayjs';
+import { existsSync } from 'fs';
+import { convert } from 'convert-gitmoji';
+
+async function execCommand(cmd, args, options) {
+  const { execa } = await import('execa');
+  const res = await execa(cmd, args, options);
+  return res?.stdout?.trim() || "";
+}
+function notNullish(v) {
+  return v !== null && v !== void 0;
+}
+function partition(array, ...filters) {
+  const result = new Array(filters.length + 1).fill(null).map(() => []);
+  array.forEach((e, idx, arr) => {
+    let i = 0;
+    for (const filter of filters) {
+      if (filter(e, idx, arr)) {
+        result[i].push(e);
+        return;
+      }
+      i += 1;
+    }
+    result[i].push(e);
+  });
+  return result;
+}
+function groupBy(items, key, groups = {}) {
+  for (const item of items) {
+    const v = item[key];
+    groups[v] = groups[v] || [];
+    groups[v].push(item);
+  }
+  return groups;
+}
+function capitalize(str) {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}
+function join(array, glue = ", ", finalGlue = " and ") {
+  if (!array || array.length === 0)
+    return "";
+  if (array.length === 1)
+    return array[0];
+  if (array.length === 2)
+    return array.join(finalGlue);
+  return `${array.slice(0, -1).join(glue)}${finalGlue}${array.slice(-1)}`;
+}
+
+const VERSION_REG = /v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?/;
+const VERSION_REG_OF_MARKDOWN = /## \[v\d+\.\d+\.\d+(-(beta|alpha)\.\d+)?]/g;
+
+async function getTotalGitTags() {
+  const tagStr = await execCommand("git", ["--no-pager", "tag", "-l", "--sort=creatordate"]);
+  const tags = tagStr.split("\n");
+  return tags;
+}
+async function getTagDateMap() {
+  const tagDateStr = await execCommand("git", [
+    "--no-pager",
+    "log",
+    "--tags",
+    "--simplify-by-decoration",
+    "--pretty=format:%ci %d"
+  ]);
+  const TAG_MARK = "tag: ";
+  const map = /* @__PURE__ */ new Map();
+  const dates = tagDateStr.split("\n").filter((item) => item.includes(TAG_MARK));
+  dates.forEach((item) => {
+    const [dateStr, tagStr] = item.split(TAG_MARK);
+    const date = dayjs(dateStr).format("YYYY-MM-DD");
+    const tag = tagStr.match(VERSION_REG)?.[0];
+    if (tag && date) {
+      map.set(tag.trim(), date);
+    }
+  });
+  return map;
+}
+function getFromToTags(tags) {
+  const result = [];
+  tags.forEach((tag, index) => {
+    if (index < tags.length - 1) {
+      result.push({ from: tag, to: tags[index + 1] });
+    }
+  });
+  return result;
+}
+async function getLastGitTag(delta = 0) {
+  const tags = await getTotalGitTags();
+  return tags[tags.length + delta - 1];
+}
+async function getGitMainBranchName() {
+  const main = await execCommand("git", ["rev-parse", "--abbrev-ref", "HEAD"]);
+  return main;
+}
+async function getCurrentGitBranch() {
+  const tag = await execCommand("git", ["tag", "--points-at", "HEAD"]);
+  const main = getGitMainBranchName();
+  return tag || main;
+}
+async function getGitHubRepo() {
+  const url = await execCommand("git", ["config", "--get", "remote.origin.url"]);
+  const match = url.match(/github\.com[/:]([\w\d._-]+?)\/([\w\d._-]+?)(\.git)?$/i);
+  if (!match) {
+    throw new Error(`Can not parse GitHub repo from url ${url}`);
+  }
+  return `${match[1]}/${match[2]}`;
+}
+function getFirstGitCommit() {
+  return execCommand("git", ["rev-list", "--max-parents=0", "HEAD"]);
+}
+async function getGitDiff(from, to = "HEAD") {
+  const rawGit = 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) => {
+    const [firstLine, ...body] = line.split("\n");
+    const [message, shortHash, authorName, authorEmail] = firstLine.split("|");
+    const gitCommmit = {
+      message,
+      shortHash,
+      author: { name: authorName, email: authorEmail },
+      body: body.join("\n")
+    };
+    return gitCommmit;
+  });
+  return gitCommits;
+}
+function parseGitCommit(commit) {
+  const ConventionalCommitRegex = /(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i;
+  const CoAuthoredByRegex = /co-authored-by:\s*(?<name>.+)(<(?<email>.+)>)/gim;
+  const PullRequestRE = /\([a-z]*(#\d+)\s*\)/gm;
+  const IssueRE = /(#\d+)/gm;
+  const match = commit.message.match(ConventionalCommitRegex);
+  if (!match?.groups) {
+    return null;
+  }
+  const type = match.groups.type;
+  const scope = match.groups.scope || "";
+  const isBreaking = Boolean(match.groups.breaking);
+  let description = match.groups.description;
+  const references = [];
+  for (const m of description.matchAll(PullRequestRE)) {
+    references.push({ type: "pull-request", value: m[1] });
+  }
+  for (const m of description.matchAll(IssueRE)) {
+    if (!references.some((i) => i.value === m[1])) {
+      references.push({ type: "issue", value: m[1] });
+    }
+  }
+  references.push({ value: commit.shortHash, type: "hash" });
+  description = description.replace(PullRequestRE, "").trim();
+  const authors = [commit.author];
+  const matchs = commit.body.matchAll(CoAuthoredByRegex);
+  for (const $match of matchs) {
+    const { name = "", email = "" } = $match.groups || {};
+    const author = {
+      name: name.trim(),
+      email: email.trim()
+    };
+    authors.push(author);
+  }
+  return {
+    ...commit,
+    authors,
+    resolvedAuthors: [],
+    description,
+    type,
+    scope,
+    references,
+    isBreaking
+  };
+}
+async function getGitCommits(from, to = "HEAD") {
+  const rwaGitCommits = await getGitDiff(from, to);
+  const commits = rwaGitCommits.map((commit) => parseGitCommit(commit)).filter(notNullish);
+  return commits;
+}
+function getHeaders(githubToken) {
+  return {
+    accept: "application/vnd.github.v3+json",
+    authorization: `token ${githubToken}`
+  };
+}
+async function getResolvedAuthorLogin(github, commitHashes, email) {
+  let login = "";
+  try {
+    const data = await ofetch(`https://ungh.cc/users/find/${email}`);
+    login = data?.user?.username || "";
+  } catch {
+  }
+  if (login) {
+    return login;
+  }
+  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 || "";
+    } catch (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;
+  } catch (e) {
+  }
+  return login;
+}
+async function getGitCommitsAndResolvedAuthors(commits, github, resolvedLogins) {
+  const resultCommits = [];
+  const map = /* @__PURE__ */ new Map();
+  for await (const commit of commits) {
+    const resolvedAuthors = [];
+    for await (const [index, author] of Object.entries(commit.authors)) {
+      const { email, name } = author;
+      if (email && name) {
+        const commitHashes = [];
+        if (index === "0") {
+          commitHashes.push(commit.shortHash);
+        }
+        const resolvedAuthor = {
+          name,
+          email,
+          commits: commitHashes,
+          login: ""
+        };
+        if (!resolvedLogins?.has(email)) {
+          const login = await getResolvedAuthorLogin(github, commitHashes, email);
+          resolvedAuthor.login = login;
+          resolvedLogins?.set(email, login);
+        } else {
+          const login = resolvedLogins?.get(email) || "";
+          resolvedAuthor.login = login;
+        }
+        resolvedAuthors.push(resolvedAuthor);
+        if (!map.has(email)) {
+          map.set(email, resolvedAuthor);
+        }
+      }
+    }
+    const resultCommit = { ...commit, resolvedAuthors };
+    resultCommits.push(resultCommit);
+  }
+  return {
+    commits: resultCommits,
+    contributors: Array.from(map.values())
+  };
+}
+
+function createDefaultOptions() {
+  const cwd = process.cwd();
+  const options = {
+    cwd,
+    types: {
+      feat: "\u{1F680} Features",
+      fix: "\u{1F41E} Bug Fixes",
+      perf: "\u{1F525} Performance",
+      refactor: "\u{1F485} Refactors",
+      docs: "\u{1F4D6} Documentation",
+      build: "\u{1F4E6} Build",
+      types: "\u{1F30A} Types",
+      chore: "\u{1F3E1} Chore",
+      examples: "\u{1F3C0} Examples",
+      test: "\u2705 Tests",
+      style: "\u{1F3A8} Styles",
+      ci: "\u{1F916} CI"
+    },
+    github: {
+      repo: "",
+      token: process.env.GITHUB_TOKEN || ""
+    },
+    from: "",
+    to: "",
+    tags: [],
+    tagDateMap: /* @__PURE__ */ new Map(),
+    capitalize: true,
+    emoji: true,
+    titles: {
+      breakingChanges: "\u{1F6A8} Breaking Changes"
+    },
+    output: "CHANGELOG.md",
+    regenerate: false,
+    newVersion: ""
+  };
+  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 || "";
+  } catch {
+  }
+  return {
+    newVersion
+  };
+}
+async function createOptions(options) {
+  var _a;
+  const opts = createDefaultOptions();
+  Object.assign(opts, options);
+  const { newVersion } = await getVersionFromPkgJson(opts.cwd);
+  (_a = opts.github).repo || (_a.repo = await getGitHubRepo());
+  opts.newVersion || (opts.newVersion = `v${newVersion}`);
+  opts.from || (opts.from = await getLastGitTag());
+  opts.to || (opts.to = await getCurrentGitBranch());
+  if (opts.to === opts.from) {
+    const lastTag = await getLastGitTag(-1);
+    const firstCommit = await getFirstGitCommit();
+    opts.from = lastTag || firstCommit;
+  }
+  opts.tags = await getTotalGitTags();
+  opts.tagDateMap = await getTagDateMap();
+  return opts;
+}
+
+function formatReferences(references, githubRepo, type) {
+  const refs = 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();
+  if (type === "issues")
+    return referencesString && `in ${referencesString}`;
+  return referencesString;
+}
+function formatLine(commit, options) {
+  const prRefs = formatReferences(commit.references, options.github.repo, "issues");
+  const hashRefs = formatReferences(commit.references, options.github.repo, "hash");
+  let authors = join([...new Set(commit.resolvedAuthors.map((i) => i.login ? `@${i.login}` : `**${i.name}**`))]).trim();
+  if (authors) {
+    authors = `by ${authors}`;
+  }
+  let refs = [authors, prRefs, 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(" ");
+}
+function formatTitle(name, options) {
+  const emojisRE = /([\u2700-\u27BF]|[\uE000-\uF8FF]|\uD83C[\uDC00-\uDFFF]|\uD83D[\uDC00-\uDFFF]|[\u2011-\u26FF]|\uD83E[\uDD10-\uDDFF])/g;
+  let formatName = name.trim();
+  if (!options.emoji) {
+    formatName = name.replace(emojisRE, "").trim();
+  }
+  return `### &nbsp;&nbsp;&nbsp;${formatName}`;
+}
+function formatSection(commits, sectionName, options) {
+  if (!commits.length)
+    return [];
+  const lines = ["", formatTitle(sectionName, options), ""];
+  const scopes = groupBy(commits, "scope");
+  let useScopeGroup = true;
+  if (!Object.entries(scopes).some(([k, v]) => k && v.length > 1)) {
+    useScopeGroup = false;
+  }
+  Object.keys(scopes).sort().forEach((scope) => {
+    let padding = "";
+    let prefix = "";
+    const scopeText = `**${scope}**`;
+    if (scope && useScopeGroup) {
+      lines.push(`- ${scopeText}:`);
+      padding = "  ";
+    } else if (scope) {
+      prefix = `${scopeText}: `;
+    }
+    lines.push(...scopes[scope].reverse().map((commit) => `${padding}- ${prefix}${formatLine(commit, options)}`));
+  });
+  return lines;
+}
+function getUserGithub(userName) {
+  const githubUrl = `https://github.com/${userName}`;
+  return githubUrl;
+}
+function getGitUserAvatar(userName) {
+  const githubUrl = getUserGithub(userName);
+  const avatarUrl = `${githubUrl}.png?size=48`;
+  return avatarUrl;
+}
+function createContributorLine(contributors) {
+  let loginLine = "";
+  let unloginLine = "";
+  contributors.forEach((contributor, index) => {
+    const { name, email, login } = contributor;
+    if (!login) {
+      let line = `[${name}](mailto:${email})`;
+      if (index < contributors.length - 1) {
+        line += ",&nbsp;";
+      }
+      unloginLine += line;
+    } else {
+      const githubUrl = getUserGithub(login);
+      const avatar = getGitUserAvatar(login);
+      loginLine += `[![${login}](${avatar})](${githubUrl})&nbsp;&nbsp;`;
+    }
+  });
+  return `${loginLine}
+${unloginLine}`;
+}
+function generateMarkdown(params) {
+  const { commits, options, showTitle, contributors } = params;
+  const lines = [];
+  const url = `https://github.com/${options.github.repo}/compare/${options.from}...${options.to}`;
+  if (showTitle) {
+    const isNewVersion = !VERSION_REG.test(options.to);
+    const version = isNewVersion ? options.newVersion : options.to;
+    const date = isNewVersion ? dayjs().format("YY-MM-DD") : options.tagDateMap.get(options.to);
+    let title = `## [${version}](${url})`;
+    if (date) {
+      title += ` (${date})`;
+    }
+    lines.push(title);
+  }
+  const [breaking, changes] = partition(commits, (c) => c.isBreaking);
+  const group = groupBy(changes, "type");
+  lines.push(...formatSection(breaking, options.titles.breakingChanges, options));
+  for (const type of Object.keys(options.types)) {
+    const items = group[type] || [];
+    lines.push(...formatSection(items, options.types[type], options));
+  }
+  if (!lines.length) {
+    lines.push("*No significant changes*");
+  }
+  if (!showTitle) {
+    lines.push("", `##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](${url})`);
+  }
+  if (showTitle) {
+    lines.push("", "### &nbsp;&nbsp;&nbsp;\u2764\uFE0F Contributors", "");
+    const contributorLine = createContributorLine(contributors);
+    lines.push(contributorLine);
+  }
+  const md = convert(lines.join("\n").trim(), true);
+  return md;
+}
+async function isVersionInMarkdown(version, mdPath) {
+  let isIn = false;
+  const md = await readFile(mdPath, "utf8");
+  if (md) {
+    const matches = md.match(VERSION_REG_OF_MARKDOWN);
+    if (matches?.length) {
+      const versionInMarkdown = `## [${version}]`;
+      isIn = matches.includes(versionInMarkdown);
+    }
+  }
+  return isIn;
+}
+async function writeMarkdown(md, mdPath, regenerate = false) {
+  let changelogMD;
+  const changelogPrefix = "# Changelog";
+  if (!regenerate && existsSync(mdPath)) {
+    changelogMD = await readFile(mdPath, "utf8");
+    if (!changelogMD.startsWith(changelogPrefix)) {
+      changelogMD = `${changelogPrefix}
+
+${changelogMD}`;
+    }
+  } else {
+    changelogMD = `${changelogPrefix}
+
+`;
+  }
+  const lastEntry = changelogMD.match(/^###?\s+.*$/m);
+  if (lastEntry) {
+    changelogMD = `${changelogMD.slice(0, lastEntry.index) + md}
+
+${changelogMD.slice(lastEntry.index)}`;
+  } else {
+    changelogMD += `
+${md}
+
+`;
+  }
+  await writeFile(mdPath, changelogMD);
+}
+
+async function getChangelogMarkdown(options) {
+  const opts = await createOptions(options);
+  const gitCommits = await getGitCommits(opts.from, opts.to);
+  const { commits, contributors } = await getGitCommitsAndResolvedAuthors(gitCommits, opts.github);
+  const markdown = generateMarkdown({ commits, options: opts, showTitle: true, contributors });
+  return markdown;
+}
+async function getTotalChangelogMarkdown(options, showProgress = true) {
+  const opts = await createOptions(options);
+  let bar = null;
+  if (showProgress) {
+    bar = new cliProgress.SingleBar(
+      { format: "generate total changelog: [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}" },
+      cliProgress.Presets.shades_classic
+    );
+  }
+  const tags = getFromToTags(opts.tags);
+  bar?.start(tags.length, 0);
+  let markdown = "";
+  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({ commits, options: { ...opts, from, to }, showTitle: true, contributors });
+    markdown = `${nextMd}
+
+${markdown}`;
+    bar?.update(index + 1);
+  }
+  bar?.stop();
+  return markdown;
+}
+async function generateChangelog(options) {
+  const opts = await createOptions(options);
+  const existContent = await isVersionInMarkdown(opts.to, opts.output);
+  if (!opts.regenerate && existContent)
+    return;
+  const markdown = await getChangelogMarkdown(opts);
+  await writeMarkdown(markdown, opts.output, opts.regenerate);
+}
+async function generateTotalChangelog(options, showProgress = true) {
+  const opts = await createOptions(options);
+  const markdown = await getTotalChangelogMarkdown(opts, showProgress);
+  await writeMarkdown(markdown, opts.output, true);
+}
+
+export { generateChangelog, generateTotalChangelog, getChangelogMarkdown, getTotalChangelogMarkdown };

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@soybeanjs/changelog",
+  "version": "0.0.1",
+  "description": "generate changelog form git tags and commits for github",
+  "author": {
+    "name": "Soybean",
+    "email": "honghuangdc@gmail.com",
+    "url": "https://github.com/honghuangdc"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/soybeanjs/changelog",
+  "repository": {
+    "url": "https://github.com/soybeanjs/changelog.git"
+  },
+  "bugs": {
+    "url": "https://github.com/soybeanjs/changelog/issues"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "cli-progress": "3.12.0",
+    "convert-gitmoji": "0.1.3",
+    "dayjs": "1.11.8",
+    "execa": "7.1.1",
+    "ofetch": "1.0.1"
+  },
+  "devDependencies": {
+    "@soybeanjs/cli": "0.5.2",
+    "@types/cli-progress": "3.11.0",
+    "@types/node": "20.2.5",
+    "eslint": "8.41.0",
+    "eslint-config-soybeanjs": "0.4.7",
+    "simple-git-hooks": "2.8.1",
+    "tsx": "3.12.7",
+    "typescript": "5.0.4",
+    "unbuild": "1.2.1"
+  },
+  "simple-git-hooks": {
+    "commit-msg": "pnpm soy git-commit-verify",
+    "pre-commit": "pnpm typecheck && pnpm soy lint-staged"
+  },
+  "github-token": "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",
+  "scripts": {
+    "build": "pnpm typecheck && unbuild",
+    "lint": "eslint . --fix",
+    "format": "soy prettier-format",
+    "commit": "soy git-commit",
+    "cleanup": "soy cleanup",
+    "update-pkg": "soy update-pkg",
+    "publish-pkg": "pnpm -r publish --access public",
+    "typecheck": "tsc --noEmit",
+    "release": "soy release && pnpm build && pnpm publish-pkg"
+  }
+}