@icebreakers/changelog-github 0.0.2 → 0.1.0

package/README.md

@@ -35,8 +35,8 @@ Run `pnpm changeset` as usual—generated changelogs will now use the enhanced f
 ## Key Differences from `@changesets/changelog-github`
 
 - **Summary tags** – recognises leading `pr:`, `commit:`, and `author:` / `user:` directives (case-insensitive) to override GitHub metadata while keeping the rest of the summary intact.
-- **Short commit links** – when you supply a `commit:` tag, the formatter renders the shortened SHA as a hyperlink rather than just the full URL.
-- **Release type callout** – appends a `> MAJOR release` style block for non-`none` releases so changelog readers can scan the impact quickly.
+- **Short commit links** – when you supply a `commit:` tag, the formatter renders the shortened SHA as a hyperlink (and shows it alongside the PR link when both are provided).
+- **Optimized formatting** – uses a clean, multi-line layout with essential metadata only. Removes redundant separators and labels for better readability on GitHub.
 - **Dotenv bootstrapping** – automatically loads `.env` before hitting the GitHub API, matching local development to CI without extra wiring.
 - **Dependency section** – lists dependency bumps with consistent Markdown indentation and links any backing commits for extra context.
 
@@ -60,10 +60,9 @@ Add optional `tailwind-config` flag to the lint preset
 The rendered changelog entry becomes:
 
 ```
-- Add optional `tailwind-config` flag to the lint preset (sonofmagic/dev-configs#42 · `1234567` · Thanks [@octocat](https://github.com/octocat)!)
+- ✨ **Add optional `tailwind-config` flag** [#42] [`1234567`](https://github.com/org/repo/commit/1234567890abcdef1234567890abcdef12345678) by @octocat
   - accepts a relative path to `tailwind.config.ts`
   - falls back to the workspace root when unset
-> MINOR release
 ```
 
 ## GitHub Authentication

package/README.zh.md

@@ -33,8 +33,8 @@ pnpm add -D @changesets/cli @icebreakers/changelog-github
 ## 与 `@changesets/changelog-github` 的差异
 
 - **摘要指令**：额外识别位于摘要首部的 `pr:`、`commit:`、`author:` / `user:`（不区分大小写），用于覆盖 GitHub 拉取的元数据，同时保留正文内容。
-- **短哈希链接**：当提供 `commit:` 指令时，会以短 SHA 生成链接，而不是仅展示完整 URL，阅读体验更好。
-- **版本类型提示**：对非 `none` 版本自动附加 `> MAJOR release`、`> MINOR release` 等提示，方便读者快速掌握影响范围。
+- **短哈希链接**：当提供 `commit:` 指令时，会以短 SHA 生成链接（若同时提供 `pr:`，会与 PR 链接并列展示），阅读体验更好。
+- **优化的格式**：采用简洁的多行布局，仅保留核心元数据，移除冗余的分隔符和标签，提升 GitHub 上的可读性。
 - **自动加载 dotenv**：在访问 GitHub API 前调用 `dotenv`，本地 CLI 与 CI 行为保持一致，无需额外手动引入。
 - **依赖更新板块**：列出依赖升级时，会根据变更集补全提交链接，并统一 Markdown 缩进，便于对齐阅读。
 
@@ -58,10 +58,9 @@ author: @octocat
 最终 changelog 会渲染为：
 
 ```
-- 为 lint preset 新增可选的 `tailwind-config` 配置项 (sonofmagic/dev-configs#42 · `1234567` · Thanks [@octocat](https://github.com/octocat)!)
+- ✨ **为 lint preset 新增可选的 `tailwind-config` 配置项** [#42] [`1234567`](https://github.com/org/repo/commit/1234567890abcdef1234567890abcdef12345678) by @octocat
   - 接受相对路径指向 `tailwind.config.ts`
   - 未设置时默认读取工作区根目录
-> MINOR release
 ```
 
 ## GitHub 鉴权

package/dist/index.cjs

@@ -37,38 +37,93 @@ async function collectDependencyReferences(changesets, repo) {
   return references.filter((link) => Boolean(link));
 }
 function formatDependencyLine(references, dependenciesUpdated) {
-  const dependencySummaries = dependenciesUpdated.map(
-    (dependency) => `\`${dependency.name}\` @ ${dependency.newVersion}`
-  );
-  const segments = [];
-  if (dependencySummaries.length > 0) {
-    segments.push(dependencySummaries.join(", "));
+  const count = dependenciesUpdated.length;
+  const firstCommit = references[0] || "";
+  if (count === 0) {
+    return firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
   }
-  if (references.length > 0) {
-    segments.push(references.join(" \xB7 "));
+  if (count <= 3) {
+    const dependencySummaries = dependenciesUpdated.map(
+      (dependency) => `\`${dependency.name}@${dependency.newVersion}\``
+    );
+    const header = firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
+    const details = `  \u2192 ${dependencySummaries.join(", ")}`;
+    return `${header}
+${details}`;
   }
-  const details = segments.join(" \xB7 ");
-  return details.length > 0 ? `- \u{1F4E6} Updated dependencies: ${details}` : "- \u{1F4E6} Updated dependencies";
+  return firstCommit ? `- \u{1F4E6} Updated ${count} dependencies ${firstCommit}` : `- \u{1F4E6} Updated ${count} dependencies`;
 }
-function parseSummary(summary) {
+function normalizeUserMentions(users) {
+  const normalized = users.map((user) => user.trim()).filter(Boolean).map((user) => user.startsWith("@") ? user : `@${user}`);
+  if (normalized.length === 0) {
+    return "";
+  }
+  if (normalized.length === 1) {
+    return normalized[0];
+  }
+  if (normalized.length === 2) {
+    return `${normalized[0]} and ${normalized[1]}`;
+  }
+  return `${normalized.slice(0, -1).join(", ")}, and ${normalized.at(-1)}`;
+}
+function extractSummaryMeta(summary) {
   let prNumber;
   let commitRef;
   const users = [];
-  const cleanedSummary = summary.replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
-    const num = Number(pr);
-    if (!Number.isNaN(num)) {
-      prNumber = num;
+  const contentLines = summary.split(/\r?\n/).filter((line) => {
+    const trimmed = line.trim();
+    const withoutListMarker = trimmed.replace(/^[-*+]\s+/, "");
+    const prMatch = withoutListMarker.match(
+      /^(?:pr|pull|pull\s*request):\s*#?(\d+)\s*$/i
+    );
+    if (prMatch) {
+      const num = Number(prMatch[1]);
+      if (!Number.isNaN(num)) {
+        prNumber = num;
+      }
+      return false;
     }
-    return "";
-  }).replace(/^\s*commit:\s*(\S+)/im, (_, commit) => {
-    commitRef = commit;
-    return "";
-  }).replace(/^\s*(?:author|user):\s*@?(\S+)/gim, (_, user) => {
-    users.push(user);
-    return "";
-  }).trim();
-  const [headline = "", ...restLines] = cleanedSummary.split("\n").map((line) => line.trimRight());
-  const detailLines = restLines.map((line) => line.trim()).map((line) => line.replace(/^\s*[-*]\s*/, "")).filter((line) => line.length > 0);
+    const commitMatch = withoutListMarker.match(/^commit:\s*(\S+)\s*$/i);
+    if (commitMatch) {
+      commitRef = commitMatch[1];
+      return false;
+    }
+    const userMatch = withoutListMarker.match(/^(?:author|user):\s*(\S+)\s*$/i);
+    if (userMatch) {
+      users.push(userMatch[1].replace(/^@/, ""));
+      return false;
+    }
+    return true;
+  }).map((line) => line.trimRight());
+  return {
+    prNumber,
+    commitRef,
+    users,
+    contentLines
+  };
+}
+function parseSummary(summary) {
+  const {
+    prNumber,
+    commitRef,
+    users,
+    contentLines
+  } = extractSummaryMeta(summary);
+  const nonEmptyIndex = contentLines.findIndex((line) => line.trim().length > 0);
+  if (nonEmptyIndex === -1) {
+    return {
+      headline: "",
+      detailLines: [],
+      prNumber,
+      commitRef,
+      users
+    };
+  }
+  const firstContentLine = contentLines[nonEmptyIndex].trim();
+  const startsWithList = /^(?:[-*+]\s+|\d+[.)]\s+)/.test(firstContentLine);
+  const headline = startsWithList ? "" : firstContentLine;
+  const restLines = startsWithList ? contentLines.slice(nonEmptyIndex) : contentLines.slice(nonEmptyIndex + 1);
+  const detailLines = restLines;
   return {
     headline,
     detailLines,
@@ -105,9 +160,35 @@ async function resolveLinks(repo, parsed, changesetCommit) {
 }
 function buildUserMentions(users, fallbackUser) {
   if (users.length > 0) {
-    return users.map((username) => `[@${username}](https://github.com/${username})`).join(", ");
+    return normalizeUserMentions(users);
   }
-  return _nullishCoalesce(fallbackUser, () => ( ""));
+  if (fallbackUser) {
+    const match = fallbackUser.match(/@([^\]]+)/);
+    return match ? normalizeUserMentions([match[1]]) : "";
+  }
+  return "";
+}
+function indentMarkdownBlock(lines, spaces) {
+  const prefix = " ".repeat(spaces);
+  return lines.map((line) => {
+    if (line.trim().length === 0) {
+      return "";
+    }
+    return `${prefix}${line}`;
+  }).join("\n");
+}
+function formatDetailBlock(detailLines) {
+  const trimmed = detailLines.join("\n").trim().split("\n").map((line) => line.trimRight());
+  const hasFence = trimmed.some((line) => /^\s*```/.test(line));
+  const isListLike = trimmed.some((line) => /^\s*(?:[-*+]\s+|\d+[.)]\s+)/.test(line));
+  if (trimmed.length === 0) {
+    return "";
+  }
+  if (hasFence || isListLike) {
+    return indentMarkdownBlock(trimmed, 2);
+  }
+  const paragraphs = trimmed.join("\n").split(/\n\s*\n/).map((chunk) => chunk.replace(/\s+/g, " ").trim()).filter(Boolean);
+  return paragraphs.map((text) => `  - ${text}`).join("\n");
 }
 var changelogFunctions = {
   async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
@@ -137,28 +218,29 @@ var changelogFunctions = {
       links.user
     );
     const headlineText = parsedSummary.headline || "Miscellaneous improvements";
-    const detailText = parsedSummary.detailLines.join(" \xB7 ");
-    const metaSegments = [];
+    const mainLineParts = [
+      `- ${releaseTypeMap[resolvedType].icon}`,
+      `**${headlineText}**`
+    ];
     if (links.pull) {
-      metaSegments.push(links.pull);
+      mainLineParts.push(links.pull);
+    } else if (links.commit) {
+      mainLineParts.push(links.commit);
     }
-    if (links.commit) {
-      metaSegments.push(links.commit);
+    if (links.pull && parsedSummary.commitRef && links.commit) {
+      mainLineParts.push(links.commit);
     }
     if (userMentions) {
-      metaSegments.push(`Thanks ${userMentions}`);
+      mainLineParts.push(`by ${userMentions}`);
     }
-    if (resolvedType !== "none") {
-      metaSegments.push(`${releaseTypeMap[resolvedType].label} release`);
-    }
-    const trailingSegments = [
-      detailText,
-      metaSegments.join(" \xB7 ")
-    ].filter((segment) => segment.length > 0);
-    const suffix = trailingSegments.length ? ` \u2014 ${trailingSegments.join(" \xB7 ")}` : "";
-    return `
+    const mainLine = mainLineParts.join(" ");
+    const detailBlock = formatDetailBlock(parsedSummary.detailLines);
+    return detailBlock.length > 0 ? `
+
+${mainLine}
+${detailBlock}` : `
 
-- ${releaseTypeMap[resolvedType].icon} **${headlineText}**${suffix}`;
+${mainLine}`;
   }
 };
 var index_default = changelogFunctions;

package/dist/index.mjs

@@ -37,38 +37,93 @@ async function collectDependencyReferences(changesets, repo) {
   return references.filter((link) => Boolean(link));
 }
 function formatDependencyLine(references, dependenciesUpdated) {
-  const dependencySummaries = dependenciesUpdated.map(
-    (dependency) => `\`${dependency.name}\` @ ${dependency.newVersion}`
-  );
-  const segments = [];
-  if (dependencySummaries.length > 0) {
-    segments.push(dependencySummaries.join(", "));
+  const count = dependenciesUpdated.length;
+  const firstCommit = references[0] || "";
+  if (count === 0) {
+    return firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
   }
-  if (references.length > 0) {
-    segments.push(references.join(" \xB7 "));
+  if (count <= 3) {
+    const dependencySummaries = dependenciesUpdated.map(
+      (dependency) => `\`${dependency.name}@${dependency.newVersion}\``
+    );
+    const header = firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
+    const details = `  \u2192 ${dependencySummaries.join(", ")}`;
+    return `${header}
+${details}`;
   }
-  const details = segments.join(" \xB7 ");
-  return details.length > 0 ? `- \u{1F4E6} Updated dependencies: ${details}` : "- \u{1F4E6} Updated dependencies";
+  return firstCommit ? `- \u{1F4E6} Updated ${count} dependencies ${firstCommit}` : `- \u{1F4E6} Updated ${count} dependencies`;
 }
-function parseSummary(summary) {
+function normalizeUserMentions(users) {
+  const normalized = users.map((user) => user.trim()).filter(Boolean).map((user) => user.startsWith("@") ? user : `@${user}`);
+  if (normalized.length === 0) {
+    return "";
+  }
+  if (normalized.length === 1) {
+    return normalized[0];
+  }
+  if (normalized.length === 2) {
+    return `${normalized[0]} and ${normalized[1]}`;
+  }
+  return `${normalized.slice(0, -1).join(", ")}, and ${normalized.at(-1)}`;
+}
+function extractSummaryMeta(summary) {
   let prNumber;
   let commitRef;
   const users = [];
-  const cleanedSummary = summary.replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
-    const num = Number(pr);
-    if (!Number.isNaN(num)) {
-      prNumber = num;
+  const contentLines = summary.split(/\r?\n/).filter((line) => {
+    const trimmed = line.trim();
+    const withoutListMarker = trimmed.replace(/^[-*+]\s+/, "");
+    const prMatch = withoutListMarker.match(
+      /^(?:pr|pull|pull\s*request):\s*#?(\d+)\s*$/i
+    );
+    if (prMatch) {
+      const num = Number(prMatch[1]);
+      if (!Number.isNaN(num)) {
+        prNumber = num;
+      }
+      return false;
     }
-    return "";
-  }).replace(/^\s*commit:\s*(\S+)/im, (_, commit) => {
-    commitRef = commit;
-    return "";
-  }).replace(/^\s*(?:author|user):\s*@?(\S+)/gim, (_, user) => {
-    users.push(user);
-    return "";
-  }).trim();
-  const [headline = "", ...restLines] = cleanedSummary.split("\n").map((line) => line.trimRight());
-  const detailLines = restLines.map((line) => line.trim()).map((line) => line.replace(/^\s*[-*]\s*/, "")).filter((line) => line.length > 0);
+    const commitMatch = withoutListMarker.match(/^commit:\s*(\S+)\s*$/i);
+    if (commitMatch) {
+      commitRef = commitMatch[1];
+      return false;
+    }
+    const userMatch = withoutListMarker.match(/^(?:author|user):\s*(\S+)\s*$/i);
+    if (userMatch) {
+      users.push(userMatch[1].replace(/^@/, ""));
+      return false;
+    }
+    return true;
+  }).map((line) => line.trimRight());
+  return {
+    prNumber,
+    commitRef,
+    users,
+    contentLines
+  };
+}
+function parseSummary(summary) {
+  const {
+    prNumber,
+    commitRef,
+    users,
+    contentLines
+  } = extractSummaryMeta(summary);
+  const nonEmptyIndex = contentLines.findIndex((line) => line.trim().length > 0);
+  if (nonEmptyIndex === -1) {
+    return {
+      headline: "",
+      detailLines: [],
+      prNumber,
+      commitRef,
+      users
+    };
+  }
+  const firstContentLine = contentLines[nonEmptyIndex].trim();
+  const startsWithList = /^(?:[-*+]\s+|\d+[.)]\s+)/.test(firstContentLine);
+  const headline = startsWithList ? "" : firstContentLine;
+  const restLines = startsWithList ? contentLines.slice(nonEmptyIndex) : contentLines.slice(nonEmptyIndex + 1);
+  const detailLines = restLines;
   return {
     headline,
     detailLines,
@@ -105,9 +160,35 @@ async function resolveLinks(repo, parsed, changesetCommit) {
 }
 function buildUserMentions(users, fallbackUser) {
   if (users.length > 0) {
-    return users.map((username) => `[@${username}](https://github.com/${username})`).join(", ");
+    return normalizeUserMentions(users);
   }
-  return fallbackUser ?? "";
+  if (fallbackUser) {
+    const match = fallbackUser.match(/@([^\]]+)/);
+    return match ? normalizeUserMentions([match[1]]) : "";
+  }
+  return "";
+}
+function indentMarkdownBlock(lines, spaces) {
+  const prefix = " ".repeat(spaces);
+  return lines.map((line) => {
+    if (line.trim().length === 0) {
+      return "";
+    }
+    return `${prefix}${line}`;
+  }).join("\n");
+}
+function formatDetailBlock(detailLines) {
+  const trimmed = detailLines.join("\n").trim().split("\n").map((line) => line.trimRight());
+  const hasFence = trimmed.some((line) => /^\s*```/.test(line));
+  const isListLike = trimmed.some((line) => /^\s*(?:[-*+]\s+|\d+[.)]\s+)/.test(line));
+  if (trimmed.length === 0) {
+    return "";
+  }
+  if (hasFence || isListLike) {
+    return indentMarkdownBlock(trimmed, 2);
+  }
+  const paragraphs = trimmed.join("\n").split(/\n\s*\n/).map((chunk) => chunk.replace(/\s+/g, " ").trim()).filter(Boolean);
+  return paragraphs.map((text) => `  - ${text}`).join("\n");
 }
 var changelogFunctions = {
   async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
@@ -137,28 +218,29 @@ var changelogFunctions = {
       links.user
     );
     const headlineText = parsedSummary.headline || "Miscellaneous improvements";
-    const detailText = parsedSummary.detailLines.join(" \xB7 ");
-    const metaSegments = [];
+    const mainLineParts = [
+      `- ${releaseTypeMap[resolvedType].icon}`,
+      `**${headlineText}**`
+    ];
     if (links.pull) {
-      metaSegments.push(links.pull);
+      mainLineParts.push(links.pull);
+    } else if (links.commit) {
+      mainLineParts.push(links.commit);
     }
-    if (links.commit) {
-      metaSegments.push(links.commit);
+    if (links.pull && parsedSummary.commitRef && links.commit) {
+      mainLineParts.push(links.commit);
     }
     if (userMentions) {
-      metaSegments.push(`Thanks ${userMentions}`);
+      mainLineParts.push(`by ${userMentions}`);
     }
-    if (resolvedType !== "none") {
-      metaSegments.push(`${releaseTypeMap[resolvedType].label} release`);
-    }
-    const trailingSegments = [
-      detailText,
-      metaSegments.join(" \xB7 ")
-    ].filter((segment) => segment.length > 0);
-    const suffix = trailingSegments.length ? ` \u2014 ${trailingSegments.join(" \xB7 ")}` : "";
-    return `
+    const mainLine = mainLineParts.join(" ");
+    const detailBlock = formatDetailBlock(parsedSummary.detailLines);
+    return detailBlock.length > 0 ? `
+
+${mainLine}
+${detailBlock}` : `
 
-- ${releaseTypeMap[resolvedType].icon} **${headlineText}**${suffix}`;
+${mainLine}`;
   }
 };
 var index_default = changelogFunctions;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/changelog-github",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Changesets GitHub changelog formatter for Icebreaker's dev-configs",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",