githublogen 0.0.1

package/README.md

@@ -0,0 +1,54 @@
+# githublogen
+
+Generate changelog for GitHub releases from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogithub](https://github.com/antfu/changelogithub).
+
+## Usage
+
+In GitHub Actions:
+
+```yml
+# .github/workflows/release.yml
+
+name: Release
+
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - run: npx githublogen
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+```
+
+It will be trigged whenever you push a tag to GitHub that starts with `v`.
+
+## Configuration
+
+You can put a configuration file in the project root, named as `githublogen.config.{json,ts,js,mjs,cjs}`, `.githublogenrc` or use the `githublogen` field in `package.json`.
+
+## Preview Locally
+
+```bash
+npx githublogen --dry
+```
+
+
+
+
+

package/dist/cli.cjs

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+'use strict';
+
+const fs = require('node:fs/promises');
+const kolorist = require('kolorist');
+const cac = require('cac');
+const index = require('./index.cjs');
+require('ohmyfetch');
+require('convert-gitmoji');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+const cac__default = /*#__PURE__*/_interopDefaultCompat(cac);
+
+const version = "0.0.1";
+
+const cli = cac__default("githublogen");
+cli.version(version).option("-t, --token <path>", "GitHub Token").option("--from <ref>", "From tag").option("--to <ref>", "To tag").option("--github <path>", "GitHub Repository, e.g. soybeanjs/githublogen").option("--name <name>", "Name of the release").option("--contributors", "Show contributors section").option("--prerelease", "Mark release as prerelease").option("-d, --draft", "Mark release as draft").option("--output <path>", "Output to file instead of sending to GitHub").option("--capitalize", "Should capitalize for each comment message").option("--emoji", "Use emojis in section titles", { default: true }).option("--group", "Nest commit messages under their scopes").option("--dry", "Dry run").help();
+cli.command("").action(async (args) => {
+  args.token = args.token || process.env.GITHUB_TOKEN;
+  try {
+    console.log();
+    console.log(kolorist.dim(`${kolorist.bold("github")}logen `) + kolorist.dim(`v${version}`));
+    const { config, md, commits } = await index.generate(args);
+    console.log(kolorist.cyan(config.from) + kolorist.dim(" -> ") + kolorist.blue(config.to) + kolorist.dim(` (${commits.length} commits)`));
+    console.log(kolorist.dim("--------------"));
+    console.log();
+    console.log(md.replace(/&nbsp;/g, ""));
+    console.log();
+    console.log(kolorist.dim("--------------"));
+    if (config.dry) {
+      console.log(kolorist.yellow("Dry run. Release skipped."));
+      return;
+    }
+    if (!config.token) {
+      console.error(kolorist.red("No GitHub token found, specify it via GITHUB_TOKEN env. Release skipped."));
+      process.exitCode = 1;
+      return;
+    }
+    if (typeof config.output === "string") {
+      await fs__default.writeFile(config.output, md, "utf-8");
+      console.log(kolorist.yellow(`Saved to ${config.output}`));
+      return;
+    }
+    if (!await index.hasTagOnGitHub(config.to, config)) {
+      console.error(kolorist.yellow(`Current ref "${kolorist.bold(config.to)}" is not available as tags on GitHub. Release skipped.`));
+      process.exitCode = 1;
+      return;
+    }
+    if (!commits.length && await index.isRepoShallow()) {
+      console.error(
+        kolorist.yellow(
+          "The repo seems to be clone shallowly, which make changelog failed to generate. You might want to specify `fetch-depth: 0` in your CI config."
+        )
+      );
+      process.exitCode = 1;
+      return;
+    }
+    await index.sendRelease(config, md);
+  } catch (e) {
+    console.error(kolorist.red(String(e)));
+    if (e?.stack)
+      console.error(kolorist.dim(e.stack?.split("\n").slice(1).join("\n")));
+    process.exit(1);
+  }
+});
+cli.parse();

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export { }

package/dist/cli.mjs

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+import fs from 'node:fs/promises';
+import { dim, bold, cyan, blue, yellow, red } from 'kolorist';
+import cac from 'cac';
+import { generate, hasTagOnGitHub, isRepoShallow, sendRelease } from './index.mjs';
+import 'ohmyfetch';
+import 'convert-gitmoji';
+
+const version = "0.0.1";
+
+const cli = cac("githublogen");
+cli.version(version).option("-t, --token <path>", "GitHub Token").option("--from <ref>", "From tag").option("--to <ref>", "To tag").option("--github <path>", "GitHub Repository, e.g. soybeanjs/githublogen").option("--name <name>", "Name of the release").option("--contributors", "Show contributors section").option("--prerelease", "Mark release as prerelease").option("-d, --draft", "Mark release as draft").option("--output <path>", "Output to file instead of sending to GitHub").option("--capitalize", "Should capitalize for each comment message").option("--emoji", "Use emojis in section titles", { default: true }).option("--group", "Nest commit messages under their scopes").option("--dry", "Dry run").help();
+cli.command("").action(async (args) => {
+  args.token = args.token || process.env.GITHUB_TOKEN;
+  try {
+    console.log();
+    console.log(dim(`${bold("github")}logen `) + dim(`v${version}`));
+    const { config, md, commits } = await generate(args);
+    console.log(cyan(config.from) + dim(" -> ") + blue(config.to) + dim(` (${commits.length} commits)`));
+    console.log(dim("--------------"));
+    console.log();
+    console.log(md.replace(/&nbsp;/g, ""));
+    console.log();
+    console.log(dim("--------------"));
+    if (config.dry) {
+      console.log(yellow("Dry run. Release skipped."));
+      return;
+    }
+    if (!config.token) {
+      console.error(red("No GitHub token found, specify it via GITHUB_TOKEN env. Release skipped."));
+      process.exitCode = 1;
+      return;
+    }
+    if (typeof config.output === "string") {
+      await fs.writeFile(config.output, md, "utf-8");
+      console.log(yellow(`Saved to ${config.output}`));
+      return;
+    }
+    if (!await hasTagOnGitHub(config.to, config)) {
+      console.error(yellow(`Current ref "${bold(config.to)}" is not available as tags on GitHub. Release skipped.`));
+      process.exitCode = 1;
+      return;
+    }
+    if (!commits.length && await isRepoShallow()) {
+      console.error(
+        yellow(
+          "The repo seems to be clone shallowly, which make changelog failed to generate. You might want to specify `fetch-depth: 0` in your CI config."
+        )
+      );
+      process.exitCode = 1;
+      return;
+    }
+    await sendRelease(config, md);
+  } catch (e) {
+    console.error(red(String(e)));
+    if (e?.stack)
+      console.error(dim(e.stack?.split("\n").slice(1).join("\n")));
+    process.exit(1);
+  }
+});
+cli.parse();

package/dist/index.cjs

@@ -0,0 +1,420 @@
+'use strict';
+
+const ohmyfetch = require('ohmyfetch');
+const kolorist = require('kolorist');
+const convertGitmoji = require('convert-gitmoji');
+
+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 notNullish(v) {
+  return v !== null && v !== void 0;
+}
+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)}`;
+}
+
+async function sendRelease(options, content) {
+  const headers = getHeaders(options);
+  let url = `https://api.github.com/repos/${options.github}/releases`;
+  let method = "POST";
+  try {
+    const exists = await ohmyfetch.$fetch(`https://api.github.com/repos/${options.github}/releases/tags/${options.to}`, {
+      headers
+    });
+    if (exists.url) {
+      url = exists.url;
+      method = "PATCH";
+    }
+  } catch (e) {
+  }
+  const body = {
+    body: content,
+    draft: options.draft || false,
+    name: options.name || options.to,
+    prerelease: options.prerelease,
+    tag_name: options.to
+  };
+  const webUrl = `https://github.com/${options.github}/releases/new?title=${encodeURIComponent(
+    String(body.name)
+  )}&body=${encodeURIComponent(String(body.body))}&tag=${encodeURIComponent(String(options.to))}&prerelease=${options.prerelease}`;
+  try {
+    console.log(kolorist.cyan(method === "POST" ? "Creating release notes..." : "Updating release notes..."));
+    const res = await ohmyfetch.$fetch(url, {
+      method,
+      body: JSON.stringify(body),
+      headers
+    });
+    console.log(kolorist.green(`Released on ${res.html_url}`));
+  } catch (e) {
+    console.log();
+    console.error(kolorist.red("Failed to create the release. Using the following link to create it manually:"));
+    console.error(kolorist.yellow(webUrl));
+    console.log();
+    throw e;
+  }
+}
+function getHeaders(options) {
+  return {
+    accept: "application/vnd.github.v3+json",
+    authorization: `token ${options.token}`
+  };
+}
+async function resolveAuthorInfo(options, info) {
+  if (info.login)
+    return info;
+  if (!options.token)
+    return info;
+  const authorInfo = { ...info };
+  try {
+    const data = await ohmyfetch.$fetch(`https://api.github.com/search/users?q=${encodeURIComponent(info.email)}`, {
+      headers: getHeaders(options)
+    });
+    authorInfo.login = data.items[0].login;
+  } catch {
+  }
+  if (info.login)
+    return info;
+  if (info.commits.length) {
+    try {
+      const data = await ohmyfetch.$fetch(`https://api.github.com/repos/${options.github}/commits/${info.commits[0]}`, {
+        headers: getHeaders(options)
+      });
+      authorInfo.login = data.author.login;
+    } catch (e) {
+    }
+  }
+  return authorInfo;
+}
+async function resolveAuthors(commits, options) {
+  const map = /* @__PURE__ */ new Map();
+  commits.forEach((commit) => {
+    commit.resolvedAuthors = commit.authors.map((a, idx) => {
+      if (!a.email || !a.name)
+        return null;
+      if (!map.has(a.email)) {
+        map.set(a.email, {
+          commits: [],
+          name: a.name,
+          email: a.email
+        });
+      }
+      const info = map.get(a.email);
+      if (idx === 0)
+        info.commits.push(commit.shortHash);
+      return info;
+    }).filter(notNullish);
+  });
+  const authors = Array.from(map.values());
+  const resolved = await Promise.all(authors.map((info) => resolveAuthorInfo(options, info)));
+  const loginSet = /* @__PURE__ */ new Set();
+  const nameSet = /* @__PURE__ */ new Set();
+  return resolved.sort((a, b) => (a.login || a.name).localeCompare(b.login || b.name)).filter((i) => {
+    if (i.login && loginSet.has(i.login))
+      return false;
+    if (i.login) {
+      loginSet.add(i.login);
+    } else {
+      if (nameSet.has(i.name))
+        return false;
+      nameSet.add(i.name);
+    }
+    return true;
+  });
+}
+async function hasTagOnGitHub(tag, options) {
+  try {
+    await ohmyfetch.$fetch(`https://api.github.com/repos/${options.github}/git/ref/tags/${tag}`, {
+      headers: getHeaders(options)
+    });
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+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]}`;
+}
+async function getCurrentGitBranch() {
+  const result1 = await execCommand("git", ["tag", "--points-at", "HEAD"]);
+  const result2 = await execCommand("git", ["rev-parse", "--abbrev-ref", "HEAD"]);
+  return result1 || result2;
+}
+async function isRepoShallow() {
+  return (await execCommand("git", ["rev-parse", "--is-shallow-repository"])).trim() === "true";
+}
+async function getLastGitTag(delta = 0) {
+  const tags = await execCommand("git", ["--no-pager", "tag", "-l", "--sort=creatordate"]).then((r) => r.split("\n"));
+  return tags[tags.length + delta - 1];
+}
+async function isRefGitTag(to) {
+  const { execa } = await import('execa');
+  try {
+    await execa("git", ["show-ref", "--verify", `refs/tags/${to}`], { reject: true });
+    return true;
+  } catch {
+    return false;
+  }
+}
+function getFirstGitCommit() {
+  return execCommand("git", ["rev-list", "--max-parents=0", "HEAD"]);
+}
+function isPrerelease(version) {
+  return !/^[^.]*[\d.]+$/.test(version);
+}
+async function execCommand(cmd, args) {
+  const { execa } = await import('execa');
+  const res = await execa(cmd, args);
+  return res.stdout.trim();
+}
+async function getGitDiff(from, to = "HEAD") {
+  const r = await execCommand("git", [
+    "--no-pager",
+    "log",
+    `${from ? `${from}...` : ""}${to}`,
+    '--pretty="----%n%s|%h|%an|%ae%n%b"',
+    "--name-status"
+  ]);
+  return r.split("----\n").splice(1).map((line) => {
+    const [firstLine, ..._body] = line.split("\n");
+    const [message, shortHash, authorName, authorEmail] = firstLine.split("|");
+    const $r = {
+      message,
+      shortHash,
+      author: { name: authorName, email: authorEmail },
+      body: _body.join("\n")
+    };
+    return $r;
+  });
+}
+
+const emojisRE = /([\u2700-\u27BF]|[\uE000-\uF8FF]|\uD83C[\uDC00-\uDFFF]|\uD83D[\uDC00-\uDFFF]|[\u2011-\u26FF]|\uD83E[\uDD10-\uDDFF])/g;
+function formatReferences(references, github, type) {
+  const refs = references.filter((i) => {
+    if (type === "issues")
+      return i.type === "issue" || i.type === "pull-request";
+    return i.type === "hash";
+  }).map((ref) => {
+    if (!github)
+      return ref.value;
+    if (ref.type === "pull-request" || ref.type === "issue")
+      return `https://github.com/${github}/issues/${ref.value.slice(1)}`;
+    return `[<samp>(${ref.value.slice(0, 5)})</samp>](https://github.com/${github}/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, "issues");
+  const hashRefs = formatReferences(commit.references, options.github, "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) {
+  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 = options.group;
+  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 = `**${options.scopeMap[scope] || scope}**`;
+    if (scope && (useScopeGroup === true || useScopeGroup === "multiple" && scopes[scope].length > 1)) {
+      lines.push(`- ${scopeText}:`);
+      padding = "  ";
+    } else if (scope) {
+      prefix = `${scopeText}: `;
+    }
+    lines.push(...scopes[scope].reverse().map((commit) => `${padding}- ${prefix}${formatLine(commit, options)}`));
+  });
+  return lines;
+}
+function generateMarkdown(commits, options) {
+  const lines = [];
+  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].title, options));
+  }
+  if (!lines.length)
+    lines.push("*No significant changes*");
+  const url = `https://github.com/${options.github}/compare/${options.from}...${options.to}`;
+  lines.push("", `##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](${url})`);
+  return convertGitmoji.convert(lines.join("\n").trim(), true);
+}
+
+function defineConfig(config) {
+  return config;
+}
+const defaultConfig = {
+  scopeMap: {},
+  types: {
+    feat: { title: "\u{1F680} Features" },
+    fix: { title: "\u{1F41E} Bug Fixes" },
+    perf: { title: "\u{1F525} Performance" },
+    refactor: { title: "\u{1F485} Refactors" },
+    docs: { title: "\u{1F4D6} Documentation" },
+    build: { title: "\u{1F4E6} Build" },
+    types: { title: "\u{1F30A} Types" },
+    chore: { title: "\u{1F3E1} Chore" },
+    examples: { title: "\u{1F3C0} Examples" },
+    test: { title: "\u2705 Tests" },
+    style: { title: "\u{1F3A8} Styles" },
+    ci: { title: "\u{1F916} CI" }
+  },
+  titles: {
+    breakingChanges: "\u{1F6A8} Breaking Changes"
+  },
+  contributors: true,
+  capitalize: true,
+  group: true
+};
+async function resolveConfig(options) {
+  const { loadConfig } = await import('c12');
+  const config = await loadConfig({
+    name: "githublogen",
+    defaults: defaultConfig,
+    overrides: options
+  }).then((r) => r.config || defaultConfig);
+  config.from = config.from || await getLastGitTag();
+  config.to = config.to || await getCurrentGitBranch();
+  config.github = config.github || await getGitHubRepo();
+  config.prerelease = config.prerelease ?? isPrerelease(config.to);
+  if (config.to === config.from)
+    config.from = await getLastGitTag(-1) || await getFirstGitCommit();
+  return config;
+}
+
+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;
+function parseGitCommit(commit, config) {
+  const match = commit.message.match(ConventionalCommitRegex);
+  if (!match?.groups) {
+    return null;
+  }
+  const type = match.groups.type;
+  let scope = match.groups.scope || "";
+  scope = config.scopeMap[scope] || 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,
+    description,
+    type,
+    scope,
+    references,
+    isBreaking
+  };
+}
+function parseCommits(commits, config) {
+  return commits.map((commit) => parseGitCommit(commit, config)).filter(notNullish);
+}
+
+async function generate(options) {
+  const resolved = await resolveConfig(options);
+  const rawCommits = await getGitDiff(resolved.from, resolved.to);
+  const commits = parseCommits(rawCommits, resolved);
+  if (resolved.contributors)
+    await resolveAuthors(commits, resolved);
+  const md = generateMarkdown(commits, resolved);
+  return { config: resolved, md, commits };
+}
+
+exports.defineConfig = defineConfig;
+exports.generate = generate;
+exports.generateMarkdown = generateMarkdown;
+exports.getCurrentGitBranch = getCurrentGitBranch;
+exports.getFirstGitCommit = getFirstGitCommit;
+exports.getGitDiff = getGitDiff;
+exports.getGitHubRepo = getGitHubRepo;
+exports.getLastGitTag = getLastGitTag;
+exports.hasTagOnGitHub = hasTagOnGitHub;
+exports.isPrerelease = isPrerelease;
+exports.isRefGitTag = isRefGitTag;
+exports.isRepoShallow = isRepoShallow;
+exports.parseCommits = parseCommits;
+exports.parseGitCommit = parseGitCommit;
+exports.resolveAuthorInfo = resolveAuthorInfo;
+exports.resolveAuthors = resolveAuthors;
+exports.resolveConfig = resolveConfig;
+exports.sendRelease = sendRelease;

package/dist/index.d.ts

@@ -0,0 +1,125 @@
+type SemverBumpType = 'major' | 'premajor' | 'minor' | 'preminor' | 'patch' | 'prepatch' | 'prerelease';
+interface ChangelogConfig {
+    cwd: string;
+    types: Record<string, {
+        title: string;
+        semver?: SemverBumpType;
+    }>;
+    scopeMap: Record<string, string>;
+    github: string;
+    from: string;
+    to: string;
+    newVersion?: string;
+    output: string | boolean;
+}
+interface GitCommitAuthor {
+    name: string;
+    email: string;
+}
+interface RawGitCommit {
+    message: string;
+    body: string;
+    shortHash: string;
+    author: GitCommitAuthor;
+}
+interface Reference {
+    type: 'hash' | 'issue' | 'pull-request';
+    value: string;
+}
+interface GitCommit extends RawGitCommit {
+    description: string;
+    type: string;
+    scope: string;
+    references: Reference[];
+    authors: GitCommitAuthor[];
+    isBreaking: boolean;
+}
+interface Commit extends GitCommit {
+    resolvedAuthors?: AuthorInfo[];
+}
+interface ChangelogOptions extends Partial<ChangelogConfig> {
+    /**
+     * Dry run. Skip releasing to GitHub.
+     */
+    dry?: boolean;
+    /**
+     * Whether to include contributors in release notes.
+     *
+     * @default true
+     */
+    contributors?: boolean;
+    /**
+     * Name of the release
+     */
+    name?: string;
+    /**
+     * Mark the release as a draft
+     */
+    draft?: boolean;
+    /**
+     * Mark the release as prerelease
+     */
+    prerelease?: boolean;
+    /**
+     * GitHub Token
+     */
+    token?: string;
+    /**
+     * Custom titles
+     */
+    titles?: {
+        breakingChanges?: string;
+    };
+    /**
+     * Capitalize commit messages
+     * @default true
+     */
+    capitalize?: boolean;
+    /**
+     * Nest commit messages under their scopes
+     * @default true
+     */
+    group?: boolean | 'multiple';
+    /**
+     * Use emojis in section titles
+     * @default true
+     */
+    emoji?: boolean;
+}
+type ResolvedChangelogOptions = Required<ChangelogOptions>;
+interface AuthorInfo {
+    commits: string[];
+    login?: string;
+    email: string;
+    name: string;
+}
+
+declare function sendRelease(options: ChangelogOptions, content: string): Promise<void>;
+declare function resolveAuthorInfo(options: ChangelogOptions, info: AuthorInfo): Promise<AuthorInfo>;
+declare function resolveAuthors(commits: Commit[], options: ChangelogOptions): Promise<AuthorInfo[]>;
+declare function hasTagOnGitHub(tag: string, options: ChangelogOptions): Promise<boolean>;
+
+declare function getGitHubRepo(): Promise<string>;
+declare function getCurrentGitBranch(): Promise<string>;
+declare function isRepoShallow(): Promise<boolean>;
+declare function getLastGitTag(delta?: number): Promise<string>;
+declare function isRefGitTag(to: string): Promise<boolean>;
+declare function getFirstGitCommit(): Promise<string>;
+declare function isPrerelease(version: string): boolean;
+declare function getGitDiff(from: string | undefined, to?: string): Promise<RawGitCommit[]>;
+
+declare function generateMarkdown(commits: Commit[], options: ResolvedChangelogOptions): string;
+
+declare function generate(options: ChangelogOptions): Promise<{
+    config: Required<ChangelogOptions>;
+    md: string;
+    commits: GitCommit[];
+}>;
+
+declare function defineConfig(config: ChangelogOptions): ChangelogOptions;
+declare function resolveConfig(options: ChangelogOptions): Promise<Required<ChangelogOptions>>;
+
+declare function parseGitCommit(commit: RawGitCommit, config: ChangelogConfig): GitCommit | null;
+declare function parseCommits(commits: RawGitCommit[], config: ChangelogConfig): GitCommit[];
+
+export { AuthorInfo, ChangelogConfig, ChangelogOptions, Commit, GitCommit, GitCommitAuthor, RawGitCommit, Reference, ResolvedChangelogOptions, SemverBumpType, defineConfig, generate, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };

package/dist/index.mjs

@@ -0,0 +1,401 @@
+import { $fetch } from 'ohmyfetch';
+import { cyan, green, red, yellow } from 'kolorist';
+import { convert } from 'convert-gitmoji';
+
+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 notNullish(v) {
+  return v !== null && v !== void 0;
+}
+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)}`;
+}
+
+async function sendRelease(options, content) {
+  const headers = getHeaders(options);
+  let url = `https://api.github.com/repos/${options.github}/releases`;
+  let method = "POST";
+  try {
+    const exists = await $fetch(`https://api.github.com/repos/${options.github}/releases/tags/${options.to}`, {
+      headers
+    });
+    if (exists.url) {
+      url = exists.url;
+      method = "PATCH";
+    }
+  } catch (e) {
+  }
+  const body = {
+    body: content,
+    draft: options.draft || false,
+    name: options.name || options.to,
+    prerelease: options.prerelease,
+    tag_name: options.to
+  };
+  const webUrl = `https://github.com/${options.github}/releases/new?title=${encodeURIComponent(
+    String(body.name)
+  )}&body=${encodeURIComponent(String(body.body))}&tag=${encodeURIComponent(String(options.to))}&prerelease=${options.prerelease}`;
+  try {
+    console.log(cyan(method === "POST" ? "Creating release notes..." : "Updating release notes..."));
+    const res = await $fetch(url, {
+      method,
+      body: JSON.stringify(body),
+      headers
+    });
+    console.log(green(`Released on ${res.html_url}`));
+  } catch (e) {
+    console.log();
+    console.error(red("Failed to create the release. Using the following link to create it manually:"));
+    console.error(yellow(webUrl));
+    console.log();
+    throw e;
+  }
+}
+function getHeaders(options) {
+  return {
+    accept: "application/vnd.github.v3+json",
+    authorization: `token ${options.token}`
+  };
+}
+async function resolveAuthorInfo(options, info) {
+  if (info.login)
+    return info;
+  if (!options.token)
+    return info;
+  const authorInfo = { ...info };
+  try {
+    const data = await $fetch(`https://api.github.com/search/users?q=${encodeURIComponent(info.email)}`, {
+      headers: getHeaders(options)
+    });
+    authorInfo.login = data.items[0].login;
+  } catch {
+  }
+  if (info.login)
+    return info;
+  if (info.commits.length) {
+    try {
+      const data = await $fetch(`https://api.github.com/repos/${options.github}/commits/${info.commits[0]}`, {
+        headers: getHeaders(options)
+      });
+      authorInfo.login = data.author.login;
+    } catch (e) {
+    }
+  }
+  return authorInfo;
+}
+async function resolveAuthors(commits, options) {
+  const map = /* @__PURE__ */ new Map();
+  commits.forEach((commit) => {
+    commit.resolvedAuthors = commit.authors.map((a, idx) => {
+      if (!a.email || !a.name)
+        return null;
+      if (!map.has(a.email)) {
+        map.set(a.email, {
+          commits: [],
+          name: a.name,
+          email: a.email
+        });
+      }
+      const info = map.get(a.email);
+      if (idx === 0)
+        info.commits.push(commit.shortHash);
+      return info;
+    }).filter(notNullish);
+  });
+  const authors = Array.from(map.values());
+  const resolved = await Promise.all(authors.map((info) => resolveAuthorInfo(options, info)));
+  const loginSet = /* @__PURE__ */ new Set();
+  const nameSet = /* @__PURE__ */ new Set();
+  return resolved.sort((a, b) => (a.login || a.name).localeCompare(b.login || b.name)).filter((i) => {
+    if (i.login && loginSet.has(i.login))
+      return false;
+    if (i.login) {
+      loginSet.add(i.login);
+    } else {
+      if (nameSet.has(i.name))
+        return false;
+      nameSet.add(i.name);
+    }
+    return true;
+  });
+}
+async function hasTagOnGitHub(tag, options) {
+  try {
+    await $fetch(`https://api.github.com/repos/${options.github}/git/ref/tags/${tag}`, {
+      headers: getHeaders(options)
+    });
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+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]}`;
+}
+async function getCurrentGitBranch() {
+  const result1 = await execCommand("git", ["tag", "--points-at", "HEAD"]);
+  const result2 = await execCommand("git", ["rev-parse", "--abbrev-ref", "HEAD"]);
+  return result1 || result2;
+}
+async function isRepoShallow() {
+  return (await execCommand("git", ["rev-parse", "--is-shallow-repository"])).trim() === "true";
+}
+async function getLastGitTag(delta = 0) {
+  const tags = await execCommand("git", ["--no-pager", "tag", "-l", "--sort=creatordate"]).then((r) => r.split("\n"));
+  return tags[tags.length + delta - 1];
+}
+async function isRefGitTag(to) {
+  const { execa } = await import('execa');
+  try {
+    await execa("git", ["show-ref", "--verify", `refs/tags/${to}`], { reject: true });
+    return true;
+  } catch {
+    return false;
+  }
+}
+function getFirstGitCommit() {
+  return execCommand("git", ["rev-list", "--max-parents=0", "HEAD"]);
+}
+function isPrerelease(version) {
+  return !/^[^.]*[\d.]+$/.test(version);
+}
+async function execCommand(cmd, args) {
+  const { execa } = await import('execa');
+  const res = await execa(cmd, args);
+  return res.stdout.trim();
+}
+async function getGitDiff(from, to = "HEAD") {
+  const r = await execCommand("git", [
+    "--no-pager",
+    "log",
+    `${from ? `${from}...` : ""}${to}`,
+    '--pretty="----%n%s|%h|%an|%ae%n%b"',
+    "--name-status"
+  ]);
+  return r.split("----\n").splice(1).map((line) => {
+    const [firstLine, ..._body] = line.split("\n");
+    const [message, shortHash, authorName, authorEmail] = firstLine.split("|");
+    const $r = {
+      message,
+      shortHash,
+      author: { name: authorName, email: authorEmail },
+      body: _body.join("\n")
+    };
+    return $r;
+  });
+}
+
+const emojisRE = /([\u2700-\u27BF]|[\uE000-\uF8FF]|\uD83C[\uDC00-\uDFFF]|\uD83D[\uDC00-\uDFFF]|[\u2011-\u26FF]|\uD83E[\uDD10-\uDDFF])/g;
+function formatReferences(references, github, type) {
+  const refs = references.filter((i) => {
+    if (type === "issues")
+      return i.type === "issue" || i.type === "pull-request";
+    return i.type === "hash";
+  }).map((ref) => {
+    if (!github)
+      return ref.value;
+    if (ref.type === "pull-request" || ref.type === "issue")
+      return `https://github.com/${github}/issues/${ref.value.slice(1)}`;
+    return `[<samp>(${ref.value.slice(0, 5)})</samp>](https://github.com/${github}/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, "issues");
+  const hashRefs = formatReferences(commit.references, options.github, "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) {
+  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 = options.group;
+  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 = `**${options.scopeMap[scope] || scope}**`;
+    if (scope && (useScopeGroup === true || useScopeGroup === "multiple" && scopes[scope].length > 1)) {
+      lines.push(`- ${scopeText}:`);
+      padding = "  ";
+    } else if (scope) {
+      prefix = `${scopeText}: `;
+    }
+    lines.push(...scopes[scope].reverse().map((commit) => `${padding}- ${prefix}${formatLine(commit, options)}`));
+  });
+  return lines;
+}
+function generateMarkdown(commits, options) {
+  const lines = [];
+  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].title, options));
+  }
+  if (!lines.length)
+    lines.push("*No significant changes*");
+  const url = `https://github.com/${options.github}/compare/${options.from}...${options.to}`;
+  lines.push("", `##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](${url})`);
+  return convert(lines.join("\n").trim(), true);
+}
+
+function defineConfig(config) {
+  return config;
+}
+const defaultConfig = {
+  scopeMap: {},
+  types: {
+    feat: { title: "\u{1F680} Features" },
+    fix: { title: "\u{1F41E} Bug Fixes" },
+    perf: { title: "\u{1F525} Performance" },
+    refactor: { title: "\u{1F485} Refactors" },
+    docs: { title: "\u{1F4D6} Documentation" },
+    build: { title: "\u{1F4E6} Build" },
+    types: { title: "\u{1F30A} Types" },
+    chore: { title: "\u{1F3E1} Chore" },
+    examples: { title: "\u{1F3C0} Examples" },
+    test: { title: "\u2705 Tests" },
+    style: { title: "\u{1F3A8} Styles" },
+    ci: { title: "\u{1F916} CI" }
+  },
+  titles: {
+    breakingChanges: "\u{1F6A8} Breaking Changes"
+  },
+  contributors: true,
+  capitalize: true,
+  group: true
+};
+async function resolveConfig(options) {
+  const { loadConfig } = await import('c12');
+  const config = await loadConfig({
+    name: "githublogen",
+    defaults: defaultConfig,
+    overrides: options
+  }).then((r) => r.config || defaultConfig);
+  config.from = config.from || await getLastGitTag();
+  config.to = config.to || await getCurrentGitBranch();
+  config.github = config.github || await getGitHubRepo();
+  config.prerelease = config.prerelease ?? isPrerelease(config.to);
+  if (config.to === config.from)
+    config.from = await getLastGitTag(-1) || await getFirstGitCommit();
+  return config;
+}
+
+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;
+function parseGitCommit(commit, config) {
+  const match = commit.message.match(ConventionalCommitRegex);
+  if (!match?.groups) {
+    return null;
+  }
+  const type = match.groups.type;
+  let scope = match.groups.scope || "";
+  scope = config.scopeMap[scope] || 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,
+    description,
+    type,
+    scope,
+    references,
+    isBreaking
+  };
+}
+function parseCommits(commits, config) {
+  return commits.map((commit) => parseGitCommit(commit, config)).filter(notNullish);
+}
+
+async function generate(options) {
+  const resolved = await resolveConfig(options);
+  const rawCommits = await getGitDiff(resolved.from, resolved.to);
+  const commits = parseCommits(rawCommits, resolved);
+  if (resolved.contributors)
+    await resolveAuthors(commits, resolved);
+  const md = generateMarkdown(commits, resolved);
+  return { config: resolved, md, commits };
+}
+
+export { defineConfig, generate, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "githublogen",
+  "type": "module",
+  "version": "0.0.1",
+  "sideEffects": false,
+  "author": {
+    "name": "SoybeanJS",
+    "email": "honghuangdc@gmail.com",
+    "url": "https://github.com/soybeanjs"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/soybeanjs/githublogen#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/soybeanjs/githublogen.git"
+  },
+  "bugs": "https://github.com/soybeanjs/githublogen/issues",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "keywords": [
+    "github",
+    "release",
+    "releases",
+    "conventional",
+    "changelog",
+    "log"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "githublogen": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "dependencies": {
+    "c12": "1.4.1",
+    "cac": "6.7.14",
+    "convert-gitmoji": "0.1.3",
+    "execa": "7.1.1",
+    "kolorist": "1.8.0",
+    "ohmyfetch": "0.4.21"
+  },
+  "devDependencies": {
+    "@soybeanjs/cli": "0.2.11",
+    "@types/node": "20.2.5",
+    "bumpp": "9.1.0",
+    "eslint": "8.41.0",
+    "eslint-config-soybeanjs": "0.4.6",
+    "lint-staged": "13.2.2",
+    "simple-git-hooks": "2.8.1",
+    "typescript": "5.0.4",
+    "unbuild": "1.2.1"
+  },
+  "simple-git-hooks": {
+    "commit-msg": "pnpm soy git-commit-verify",
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*.{js,mjs,jsx,ts,mts,tsx,json,vue,svelte}": "eslint . --fix",
+    "*.!{js,mjs,jsx,ts,mts,tsx,json,vue,svelte}": "format"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "lint": "eslint . --fix",
+    "format": "soy prettier-format",
+    "commit": "soy git-commit",
+    "cleanup": "soy cleanup",
+    "update-pkg": "soy update-pkg",
+    "update-version": "bumpp --commit --push --tag",
+    "publish-pkg": "pnpm -r publish --access public",
+    "release": "pnpm update-version && pnpm publish-pkg"
+  }
+}