githublogen 0.2.0 → 0.2.2

package/README.md

@@ -2,6 +2,8 @@
 
 Generate changelog for GitHub releases from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogithub](https://github.com/antfu/changelogithub).
 
+Auto Generate CHANGELOG.md from [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogen](https://github.com/unjs/changelogen).
+
 ## Usage
 
 In GitHub Actions:

package/dist/cli.cjs

@@ -1,13 +1,12 @@
 #!/usr/bin/env node
 'use strict';
 
-const fs = require('node:fs');
 const kolorist = require('kolorist');
-const execa = require('execa');
 const cac = require('cac');
 const index = require('./index.cjs');
 require('ohmyfetch');
 require('convert-gitmoji');
+require('node:fs');
 require('node:module');
 require('node:url');
 require('node:assert');
@@ -20,7 +19,7 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 
 const cac__default = /*#__PURE__*/_interopDefaultCompat(cac);
 
-const version = "0.2.0";
+const version = "0.2.2";
 
 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();
@@ -29,7 +28,7 @@ cli.command("").action(async (args) => {
     console.log();
     console.log(kolorist.dim(`${kolorist.bold("github")}logen `) + kolorist.dim(`v${version}`));
     const cwd = process.cwd();
-    const { config, md, changelog, commits } = await index.generate(cwd, args);
+    const { config, md, commits } = await index.generate(cwd, args);
     const markdown = md.replace(/&nbsp;/g, "");
     console.log(kolorist.cyan(config.from) + kolorist.dim(" -> ") + kolorist.blue(config.to) + kolorist.dim(` (${commits.length} commits)`));
     console.log(kolorist.dim("--------------"));
@@ -41,46 +40,6 @@ cli.command("").action(async (args) => {
       console.log(kolorist.yellow("Dry run. Release skipped."));
       return;
     }
-    if (typeof config.output === "string") {
-      const pushUrl = index.getGitPushUrl(config.repo, config.tokens.github);
-      if (!pushUrl) {
-        return;
-      }
-      let changelogMD;
-      const changelogPrefix = "# Changelog";
-      if (fs.existsSync(config.output)) {
-        console.info(`Updating ${config.output}`);
-        changelogMD = await fs.promises.readFile(config.output, "utf8");
-        if (!changelogMD.startsWith(changelogPrefix)) {
-          changelogMD = `${changelogPrefix}
-
-${changelogMD}`;
-        }
-      } else {
-        console.info(`Creating  ${config.output}`);
-        changelogMD = `${changelogPrefix}
-
-`;
-      }
-      const lastEntry = changelogMD.match(/^###?\s+.*$/m);
-      if (lastEntry) {
-        changelogMD = `${changelogMD.slice(0, lastEntry.index) + changelog}
-
-${changelogMD.slice(lastEntry.index)}`;
-      } else {
-        changelogMD += `
-${changelog}
-
-`;
-      }
-      await fs.promises.writeFile(config.output, changelogMD);
-      const { email = "unknow@unknow.com", name = "unknow" } = commits[0]?.author || {};
-      await execa.execa("git", ["config", "--global", "user.email", `"${email}"`]);
-      await execa.execa("git", ["config", "--global", "user.name", `"${name}"`]);
-      await execa.execa("git", ["add", "."]);
-      await execa.execa("git", ["commit", "-m docs(projects): CHANGELOG.md"], { cwd });
-      await execa.execa("git", ["push", pushUrl, `HEAD:${config.gitMainBranch}`], { cwd });
-    }
     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;

package/dist/cli.mjs

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
-import { existsSync, promises } from 'node:fs';
 import { dim, bold, cyan, blue, yellow, red } from 'kolorist';
-import { execa } from 'execa';
 import cac from 'cac';
-import { generate, getGitPushUrl, hasTagOnGitHub, isRepoShallow, sendRelease } from './index.mjs';
+import { generate, hasTagOnGitHub, isRepoShallow, sendRelease } from './index.mjs';
 import 'ohmyfetch';
 import 'convert-gitmoji';
+import 'node:fs';
 import 'node:module';
 import 'node:url';
 import 'node:assert';
@@ -14,7 +13,7 @@ import 'node:path';
 import 'node:v8';
 import 'node:util';
 
-const version = "0.2.0";
+const version = "0.2.2";
 
 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();
@@ -23,7 +22,7 @@ cli.command("").action(async (args) => {
     console.log();
     console.log(dim(`${bold("github")}logen `) + dim(`v${version}`));
     const cwd = process.cwd();
-    const { config, md, changelog, commits } = await generate(cwd, args);
+    const { config, md, commits } = await generate(cwd, args);
     const markdown = md.replace(/&nbsp;/g, "");
     console.log(cyan(config.from) + dim(" -> ") + blue(config.to) + dim(` (${commits.length} commits)`));
     console.log(dim("--------------"));
@@ -35,46 +34,6 @@ cli.command("").action(async (args) => {
       console.log(yellow("Dry run. Release skipped."));
       return;
     }
-    if (typeof config.output === "string") {
-      const pushUrl = getGitPushUrl(config.repo, config.tokens.github);
-      if (!pushUrl) {
-        return;
-      }
-      let changelogMD;
-      const changelogPrefix = "# Changelog";
-      if (existsSync(config.output)) {
-        console.info(`Updating ${config.output}`);
-        changelogMD = await promises.readFile(config.output, "utf8");
-        if (!changelogMD.startsWith(changelogPrefix)) {
-          changelogMD = `${changelogPrefix}
-
-${changelogMD}`;
-        }
-      } else {
-        console.info(`Creating  ${config.output}`);
-        changelogMD = `${changelogPrefix}
-
-`;
-      }
-      const lastEntry = changelogMD.match(/^###?\s+.*$/m);
-      if (lastEntry) {
-        changelogMD = `${changelogMD.slice(0, lastEntry.index) + changelog}
-
-${changelogMD.slice(lastEntry.index)}`;
-      } else {
-        changelogMD += `
-${changelog}
-
-`;
-      }
-      await promises.writeFile(config.output, changelogMD);
-      const { email = "unknow@unknow.com", name = "unknow" } = commits[0]?.author || {};
-      await execa("git", ["config", "--global", "user.email", `"${email}"`]);
-      await execa("git", ["config", "--global", "user.name", `"${name}"`]);
-      await execa("git", ["add", "."]);
-      await execa("git", ["commit", "-m docs(projects): CHANGELOG.md"], { cwd });
-      await execa("git", ["push", pushUrl, `HEAD:${config.gitMainBranch}`], { cwd });
-    }
     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;

package/dist/index.cjs

@@ -58,9 +58,6 @@ function join$1(array, glue = ", ", finalGlue = " and ") {
     return array.join(finalGlue);
   return `${array.slice(0, -1).join(glue)}${finalGlue}${array.slice(-1)}`;
 }
-function upperFirst(string) {
-  return !string ? "" : string[0].toUpperCase() + string.slice(1);
-}
 
 async function sendRelease(options, content) {
   const headers = getHeaders(options);
@@ -258,6 +255,92 @@ function getGitPushUrl(config, token) {
   return `https://${token}@${config.domain}/${config.repo}`;
 }
 
+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$1(refs).trim();
+  if (type === "issues") {
+    return referencesString && `in ${referencesString}`;
+  }
+  return referencesString;
+}
+function formatLine(commit, options) {
+  const prRefs = formatReferences(commit.references, options.repo.repo || "", "issues");
+  const hashRefs = formatReferences(commit.references, options.repo.repo || "", "hash");
+  let authors = join$1([
+    ...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 $name = name.trim();
+  if (!options.emoji) {
+    $name = name.replace(emojisRE, "").trim();
+  }
+  return `### &nbsp;&nbsp;&nbsp;${$name}`;
+}
+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.repo.repo}/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 normalizeWindowsPath(input = "") {
   if (!input || !input.includes("\\")) {
     return input;
@@ -8064,15 +8147,6 @@ async function resolvePackageJSON(id = process.cwd(), options = {}) {
   });
 }
 
-const providerToRefSpec = {
-  github: { "pull-request": "pull", hash: "commit", issue: "issues" },
-  gitlab: { "pull-request": "merge_requests", hash: "commit", issue: "issues" },
-  bitbucket: {
-    "pull-request": "pull-requests",
-    hash: "commit",
-    issue: "issues"
-  }
-};
 const providerToDomain = {
   github: "github.com",
   gitlab: "gitlab.com",
@@ -8084,16 +8158,6 @@ const domainToProvider = {
   "bitbucket.org": "bitbucket"
 };
 const providerURLRegex = /^(?:(?<user>\w+)@)?(?:(?<provider>[^/:]+):)?(?<repo>\w+\/\w+)(?:\.git)?$/;
-function baseUrl$1(config) {
-  return `https://${config.domain}/${config.repo}`;
-}
-function formatReference(ref, repo) {
-  if (!repo?.provider || !(repo.provider in providerToRefSpec)) {
-    return ref.value;
-  }
-  const refSpec = providerToRefSpec[repo.provider];
-  return `[${ref.value}](${baseUrl$1(repo)}/${refSpec[ref.type]}/${ref.value.replace(/^#/, "")})`;
-}
 async function resolveRepoConfig(cwd) {
   const pkg = await readPackageJSON(cwd).catch(() => {
   });
@@ -8138,189 +8202,6 @@ function getRepoConfig(repoUrl = "") {
   };
 }
 
-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$1(refs).trim();
-  if (type === "issues") {
-    return referencesString && `in ${referencesString}`;
-  }
-  return referencesString;
-}
-function formatLine(commit, options) {
-  const prRefs = formatReferences(commit.references, options.repo.repo || "", "issues");
-  const hashRefs = formatReferences(commit.references, options.repo.repo || "", "hash");
-  let authors = join$1([
-    ...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 $name = name.trim();
-  if (!options.emoji) {
-    $name = name.replace(emojisRE, "").trim();
-  }
-  return `### &nbsp;&nbsp;&nbsp;${$name}`;
-}
-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.repo.repo}/compare/${options.from}...${options.to}`;
-  lines.push("", `##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](${url})`);
-  return convertGitmoji.convert(lines.join("\n").trim(), true);
-}
-async function generateChangelog(commits, config) {
-  const typeGroups = groupBy(commits, "type");
-  const markdown = [];
-  const breakingChanges = [];
-  const v = config.newVersion && `v${config.newVersion}`;
-  markdown.push("", `## ${v || `${config.from || ""}...${config.to}`}`, "");
-  if (config.repo && config.from) {
-    markdown.push(formatCompareChanges(v, config));
-  }
-  const typeKeys = Object.keys(config.types);
-  typeKeys.forEach((typeKey) => {
-    const group = typeGroups[typeKey];
-    if (group?.length) {
-      markdown.push("", `### ${config.types[typeKey].title}`, "");
-      for (const commit of group.reverse()) {
-        const line = formatCommit(commit, config);
-        markdown.push(line);
-        if (commit.isBreaking) {
-          breakingChanges.push(line);
-        }
-      }
-    }
-  });
-  if (breakingChanges.length > 0) {
-    markdown.push("", "#### \u26A0\uFE0F  Breaking Changes", "", ...breakingChanges);
-  }
-  const authorMap = /* @__PURE__ */ new Map();
-  commits.forEach((commit) => {
-    const name = formatName(commit.author?.name || "");
-    if (name && !name.includes("[bot]")) {
-      if (!authorMap.has(name)) {
-        authorMap.set(name, { email: /* @__PURE__ */ new Set([commit.author.email]) });
-      } else {
-        const entry = authorMap.get(name);
-        entry?.email?.add(commit.author.email);
-      }
-    }
-  });
-  await Promise.all(
-    [...authorMap.keys()].map(async (authorName) => {
-      const meta = authorMap.get(authorName);
-      if (meta) {
-        for (const email of meta.email) {
-          try {
-            const { user } = await ohmyfetch.$fetch(`https://ungh.cc/users/find/${email}`);
-            if (user) {
-              meta.github = user.username;
-              break;
-            }
-          } catch {
-          }
-        }
-      }
-    })
-  );
-  const authors = [...authorMap.entries()].map((e) => ({ name: e[0], ...e[1] }));
-  if (authors.length > 0) {
-    markdown.push(
-      "",
-      "### \u2764\uFE0F Contributors",
-      "",
-      ...authors.map((i) => {
-        const $email = [...i.email].find((e) => !e.includes("noreply.github.com"));
-        const email = $email ? `<${$email}>` : "";
-        const github = i.github ? `([@${i.github}](http://github.com/${i.github}))` : "";
-        return `- ${i.name} ${github || email}`;
-      })
-    );
-  }
-  return convertGitmoji.convert(markdown.join("\n").trim(), true);
-}
-function baseUrl(config) {
-  return `https://${config.domain}/${config.repo}`;
-}
-function formatCompareChanges(v, config) {
-  const part = config.repo.provider === "bitbucket" ? "branches/compare" : "compare";
-  return `[compare changes](${baseUrl(config.repo)}/${part}/${config.from}...${v || config.to})`;
-}
-function formatCommit(commit, config) {
-  return `- ${commit.scope ? `**${commit.scope.trim()}:** ` : ""}${commit.isBreaking ? "\u26A0\uFE0F  " : ""}${upperFirst(
-    commit.description
-  )}${formatMultiReference(commit.references, config)}`;
-}
-function formatName(name = "") {
-  return name.split(" ").map((p) => upperFirst(p.trim())).join(" ");
-}
-function formatMultiReference(references, config) {
-  const pr = references.filter((ref) => ref.type === "pull-request");
-  const issue = references.filter((ref) => ref.type === "issue");
-  if (pr.length > 0 || issue.length > 0) {
-    return ` (${[...pr, ...issue].map((ref) => formatReference(ref, config.repo)).join(", ")})`;
-  }
-  if (references.length > 0) {
-    return ` (${formatReference(references[0], config.repo)})`;
-  }
-  return "";
-}
-
 const defaultConfig = {
   cwd: process.cwd(),
   from: "",
@@ -8427,12 +8308,10 @@ async function generate(cwd, options) {
     await resolveAuthors(commits, resolved);
   }
   const md = generateMarkdown(commits, resolved);
-  const changelog = await generateChangelog(commits, resolved);
-  return { config: resolved, md, commits, changelog };
+  return { config: resolved, md, commits };
 }
 
 exports.generate = generate;
-exports.generateChangelog = generateChangelog;
 exports.generateMarkdown = generateMarkdown;
 exports.getCurrentGitBranch = getCurrentGitBranch;
 exports.getFirstGitCommit = getFirstGitCommit;

package/dist/index.d.ts

@@ -129,13 +129,11 @@ declare function getGitRemoteURL(cwd: string, remote?: string): Promise<string>;
 declare function getGitPushUrl(config: RepoConfig, token?: string): string | null;
 
 declare function generateMarkdown(commits: Commit[], options: ResolvedChangelogOptions): string;
-declare function generateChangelog(commits: Commit[], config: ResolvedChangelogOptions): Promise<string>;
 
 declare function generate(cwd: string, options: ChangelogOptions): Promise<{
     config: Required<ChangelogOptions>;
     md: string;
     commits: GitCommit[];
-    changelog: string;
 }>;
 
 declare function resolveConfig(cwd: string, options: ChangelogOptions): Promise<Required<ChangelogOptions>>;
@@ -143,4 +141,4 @@ declare function resolveConfig(cwd: string, options: ChangelogOptions): Promise<
 declare function parseGitCommit(commit: RawGitCommit, config: ChangelogConfig): GitCommit | null;
 declare function parseCommits(commits: RawGitCommit[], config: ChangelogConfig): GitCommit[];
 
-export { AuthorInfo, ChangelogConfig, ChangelogOptions, Commit, GitCommit, GitCommitAuthor, GithubOptions, GithubRelease, RawGitCommit, Reference, RepoConfig, RepoProvider, ResolvedChangelogOptions, SemverBumpType, generate, generateChangelog, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getGitMainBranchName, getGitPushUrl, getGitRemoteURL, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };
+export { AuthorInfo, ChangelogConfig, ChangelogOptions, Commit, GitCommit, GitCommitAuthor, GithubOptions, GithubRelease, RawGitCommit, Reference, RepoConfig, RepoProvider, ResolvedChangelogOptions, SemverBumpType, generate, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getGitMainBranchName, getGitPushUrl, getGitRemoteURL, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };

package/dist/index.mjs

@@ -48,9 +48,6 @@ function join$1(array, glue = ", ", finalGlue = " and ") {
     return array.join(finalGlue);
   return `${array.slice(0, -1).join(glue)}${finalGlue}${array.slice(-1)}`;
 }
-function upperFirst(string) {
-  return !string ? "" : string[0].toUpperCase() + string.slice(1);
-}
 
 async function sendRelease(options, content) {
   const headers = getHeaders(options);
@@ -248,6 +245,92 @@ function getGitPushUrl(config, token) {
   return `https://${token}@${config.domain}/${config.repo}`;
 }
 
+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$1(refs).trim();
+  if (type === "issues") {
+    return referencesString && `in ${referencesString}`;
+  }
+  return referencesString;
+}
+function formatLine(commit, options) {
+  const prRefs = formatReferences(commit.references, options.repo.repo || "", "issues");
+  const hashRefs = formatReferences(commit.references, options.repo.repo || "", "hash");
+  let authors = join$1([
+    ...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 $name = name.trim();
+  if (!options.emoji) {
+    $name = name.replace(emojisRE, "").trim();
+  }
+  return `### &nbsp;&nbsp;&nbsp;${$name}`;
+}
+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.repo.repo}/compare/${options.from}...${options.to}`;
+  lines.push("", `##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](${url})`);
+  return convert(lines.join("\n").trim(), true);
+}
+
 function normalizeWindowsPath(input = "") {
   if (!input || !input.includes("\\")) {
     return input;
@@ -8054,15 +8137,6 @@ async function resolvePackageJSON(id = process.cwd(), options = {}) {
   });
 }
 
-const providerToRefSpec = {
-  github: { "pull-request": "pull", hash: "commit", issue: "issues" },
-  gitlab: { "pull-request": "merge_requests", hash: "commit", issue: "issues" },
-  bitbucket: {
-    "pull-request": "pull-requests",
-    hash: "commit",
-    issue: "issues"
-  }
-};
 const providerToDomain = {
   github: "github.com",
   gitlab: "gitlab.com",
@@ -8074,16 +8148,6 @@ const domainToProvider = {
   "bitbucket.org": "bitbucket"
 };
 const providerURLRegex = /^(?:(?<user>\w+)@)?(?:(?<provider>[^/:]+):)?(?<repo>\w+\/\w+)(?:\.git)?$/;
-function baseUrl$1(config) {
-  return `https://${config.domain}/${config.repo}`;
-}
-function formatReference(ref, repo) {
-  if (!repo?.provider || !(repo.provider in providerToRefSpec)) {
-    return ref.value;
-  }
-  const refSpec = providerToRefSpec[repo.provider];
-  return `[${ref.value}](${baseUrl$1(repo)}/${refSpec[ref.type]}/${ref.value.replace(/^#/, "")})`;
-}
 async function resolveRepoConfig(cwd) {
   const pkg = await readPackageJSON(cwd).catch(() => {
   });
@@ -8128,189 +8192,6 @@ function getRepoConfig(repoUrl = "") {
   };
 }
 
-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$1(refs).trim();
-  if (type === "issues") {
-    return referencesString && `in ${referencesString}`;
-  }
-  return referencesString;
-}
-function formatLine(commit, options) {
-  const prRefs = formatReferences(commit.references, options.repo.repo || "", "issues");
-  const hashRefs = formatReferences(commit.references, options.repo.repo || "", "hash");
-  let authors = join$1([
-    ...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 $name = name.trim();
-  if (!options.emoji) {
-    $name = name.replace(emojisRE, "").trim();
-  }
-  return `### &nbsp;&nbsp;&nbsp;${$name}`;
-}
-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.repo.repo}/compare/${options.from}...${options.to}`;
-  lines.push("", `##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](${url})`);
-  return convert(lines.join("\n").trim(), true);
-}
-async function generateChangelog(commits, config) {
-  const typeGroups = groupBy(commits, "type");
-  const markdown = [];
-  const breakingChanges = [];
-  const v = config.newVersion && `v${config.newVersion}`;
-  markdown.push("", `## ${v || `${config.from || ""}...${config.to}`}`, "");
-  if (config.repo && config.from) {
-    markdown.push(formatCompareChanges(v, config));
-  }
-  const typeKeys = Object.keys(config.types);
-  typeKeys.forEach((typeKey) => {
-    const group = typeGroups[typeKey];
-    if (group?.length) {
-      markdown.push("", `### ${config.types[typeKey].title}`, "");
-      for (const commit of group.reverse()) {
-        const line = formatCommit(commit, config);
-        markdown.push(line);
-        if (commit.isBreaking) {
-          breakingChanges.push(line);
-        }
-      }
-    }
-  });
-  if (breakingChanges.length > 0) {
-    markdown.push("", "#### \u26A0\uFE0F  Breaking Changes", "", ...breakingChanges);
-  }
-  const authorMap = /* @__PURE__ */ new Map();
-  commits.forEach((commit) => {
-    const name = formatName(commit.author?.name || "");
-    if (name && !name.includes("[bot]")) {
-      if (!authorMap.has(name)) {
-        authorMap.set(name, { email: /* @__PURE__ */ new Set([commit.author.email]) });
-      } else {
-        const entry = authorMap.get(name);
-        entry?.email?.add(commit.author.email);
-      }
-    }
-  });
-  await Promise.all(
-    [...authorMap.keys()].map(async (authorName) => {
-      const meta = authorMap.get(authorName);
-      if (meta) {
-        for (const email of meta.email) {
-          try {
-            const { user } = await $fetch(`https://ungh.cc/users/find/${email}`);
-            if (user) {
-              meta.github = user.username;
-              break;
-            }
-          } catch {
-          }
-        }
-      }
-    })
-  );
-  const authors = [...authorMap.entries()].map((e) => ({ name: e[0], ...e[1] }));
-  if (authors.length > 0) {
-    markdown.push(
-      "",
-      "### \u2764\uFE0F Contributors",
-      "",
-      ...authors.map((i) => {
-        const $email = [...i.email].find((e) => !e.includes("noreply.github.com"));
-        const email = $email ? `<${$email}>` : "";
-        const github = i.github ? `([@${i.github}](http://github.com/${i.github}))` : "";
-        return `- ${i.name} ${github || email}`;
-      })
-    );
-  }
-  return convert(markdown.join("\n").trim(), true);
-}
-function baseUrl(config) {
-  return `https://${config.domain}/${config.repo}`;
-}
-function formatCompareChanges(v, config) {
-  const part = config.repo.provider === "bitbucket" ? "branches/compare" : "compare";
-  return `[compare changes](${baseUrl(config.repo)}/${part}/${config.from}...${v || config.to})`;
-}
-function formatCommit(commit, config) {
-  return `- ${commit.scope ? `**${commit.scope.trim()}:** ` : ""}${commit.isBreaking ? "\u26A0\uFE0F  " : ""}${upperFirst(
-    commit.description
-  )}${formatMultiReference(commit.references, config)}`;
-}
-function formatName(name = "") {
-  return name.split(" ").map((p) => upperFirst(p.trim())).join(" ");
-}
-function formatMultiReference(references, config) {
-  const pr = references.filter((ref) => ref.type === "pull-request");
-  const issue = references.filter((ref) => ref.type === "issue");
-  if (pr.length > 0 || issue.length > 0) {
-    return ` (${[...pr, ...issue].map((ref) => formatReference(ref, config.repo)).join(", ")})`;
-  }
-  if (references.length > 0) {
-    return ` (${formatReference(references[0], config.repo)})`;
-  }
-  return "";
-}
-
 const defaultConfig = {
   cwd: process.cwd(),
   from: "",
@@ -8417,8 +8298,7 @@ async function generate(cwd, options) {
     await resolveAuthors(commits, resolved);
   }
   const md = generateMarkdown(commits, resolved);
-  const changelog = await generateChangelog(commits, resolved);
-  return { config: resolved, md, commits, changelog };
+  return { config: resolved, md, commits };
 }
 
-export { generate, generateChangelog, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getGitMainBranchName, getGitPushUrl, getGitRemoteURL, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };
+export { generate, generateMarkdown, getCurrentGitBranch, getFirstGitCommit, getGitDiff, getGitHubRepo, getGitMainBranchName, getGitPushUrl, getGitRemoteURL, getLastGitTag, hasTagOnGitHub, isPrerelease, isRefGitTag, isRepoShallow, parseCommits, parseGitCommit, resolveAuthorInfo, resolveAuthors, resolveConfig, sendRelease };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "githublogen",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "sideEffects": false,
   "author": {
     "name": "SoybeanJS",
@@ -54,36 +54,29 @@
     "ohmyfetch": "0.4.21"
   },
   "devDependencies": {
-    "@soybeanjs/cli": "0.2.11",
+    "@soybeanjs/cli": "0.5.0",
     "@types/node": "20.2.5",
-    "bumpp": "9.1.0",
-    "changelogen": "^0.5.3",
-    "eslint": "8.41.0",
-    "eslint-config-soybeanjs": "0.4.6",
-    "lint-staged": "13.2.2",
+    "eslint": "8.42.0",
+    "eslint-config-soybeanjs": "0.4.8",
     "simple-git-hooks": "2.8.1",
-    "tsx": "^3.12.7",
-    "typescript": "5.0.4",
+    "tsx": "3.12.7",
+    "typescript": "5.1.3",
     "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"
+    "pre-commit": "pnpm soy lint-staged"
   },
+  "github-token": "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",
   "scripts": {
-    "build": "unbuild",
+    "build": "pnpm typecheck && 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 build && pnpm publish-pkg",
+    "release": "pnpm soy release && pnpm build && pnpm publish-pkg",
     "typecheck": "tsc --noEmit"
   }
 }