@icebreakers/changelog-github 0.1.0 → 0.2.0

package/dist/index.cjs

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }// src/index.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/index.ts
 var _getgithubinfo = require('@changesets/get-github-info');
 var _dotenv = require('dotenv');
 _dotenv.config.call(void 0, );
@@ -34,7 +34,7 @@ async function collectDependencyReferences(changesets, repo) {
       return links.commit;
     })
   );
-  return references.filter((link) => Boolean(link));
+  return [...new Set(references.filter((link) => Boolean(link)))];
 }
 function formatDependencyLine(references, dependenciesUpdated) {
   const count = dependenciesUpdated.length;
@@ -42,16 +42,50 @@ function formatDependencyLine(references, dependenciesUpdated) {
   if (count === 0) {
     return firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
   }
+  const dependencySummaries = dependenciesUpdated.map(
+    (dependency) => `\`${dependency.name}@${dependency.newVersion}\``
+  );
   if (count <= 3) {
-    const dependencySummaries = dependenciesUpdated.map(
-      (dependency) => `\`${dependency.name}@${dependency.newVersion}\``
-    );
-    const header = firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
+    const header2 = firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
     const details = `  \u2192 ${dependencySummaries.join(", ")}`;
-    return `${header}
+    return `${header2}
 ${details}`;
   }
-  return firstCommit ? `- \u{1F4E6} Updated ${count} dependencies ${firstCommit}` : `- \u{1F4E6} Updated ${count} dependencies`;
+  const header = firstCommit ? `- \u{1F4E6} Updated ${count} dependencies ${firstCommit}` : `- \u{1F4E6} Updated ${count} dependencies`;
+  const detailBlock = [
+    "  <details><summary>Details</summary>",
+    "",
+    `  ${dependencySummaries.join(", ")}`,
+    "",
+    "  </details>"
+  ].join("\n");
+  return `${header}
+${detailBlock}`;
+}
+function parseConventionalHeadline(raw) {
+  const match = raw.match(
+    /^(\w+)(?:\(([^)]*)\))?(!?):\s(.+)$/
+  );
+  if (!match) {
+    return { breaking: false, description: raw };
+  }
+  return {
+    type: match[1],
+    scope: match[2] || void 0,
+    breaking: match[3] === "!",
+    description: match[4].trim()
+  };
+}
+function formatHeadline(raw) {
+  const parsed = parseConventionalHeadline(raw);
+  if (!parsed.type) {
+    return { text: raw, breaking: parsed.breaking };
+  }
+  const scopeTag = parsed.scope ? `${parsed.scope}: ` : "";
+  return {
+    text: `${scopeTag}${parsed.description}`,
+    breaking: parsed.breaking
+  };
 }
 function normalizeUserMentions(users) {
   const normalized = users.map((user) => user.trim()).filter(Boolean).map((user) => user.startsWith("@") ? user : `@${user}`);
@@ -69,6 +103,7 @@ function normalizeUserMentions(users) {
 function extractSummaryMeta(summary) {
   let prNumber;
   let commitRef;
+  let breaking = false;
   const users = [];
   const contentLines = summary.split(/\r?\n/).filter((line) => {
     const trimmed = line.trim();
@@ -93,13 +128,17 @@ function extractSummaryMeta(summary) {
       users.push(userMatch[1].replace(/^@/, ""));
       return false;
     }
+    if (/^BREAKING[\s-]CHANGE:/i.test(withoutListMarker)) {
+      breaking = true;
+    }
     return true;
-  }).map((line) => line.trimRight());
+  }).map((line) => line.trimEnd());
   return {
     prNumber,
     commitRef,
     users,
-    contentLines
+    contentLines,
+    breaking
   };
 }
 function parseSummary(summary) {
@@ -107,7 +146,8 @@ function parseSummary(summary) {
     prNumber,
     commitRef,
     users,
-    contentLines
+    contentLines,
+    breaking: bodyBreaking
   } = extractSummaryMeta(summary);
   const nonEmptyIndex = contentLines.findIndex((line) => line.trim().length > 0);
   if (nonEmptyIndex === -1) {
@@ -116,7 +156,8 @@ function parseSummary(summary) {
       detailLines: [],
       prNumber,
       commitRef,
-      users
+      users,
+      breaking: bodyBreaking
     };
   }
   const firstContentLine = contentLines[nonEmptyIndex].trim();
@@ -124,12 +165,15 @@ function parseSummary(summary) {
   const headline = startsWithList ? "" : firstContentLine;
   const restLines = startsWithList ? contentLines.slice(nonEmptyIndex) : contentLines.slice(nonEmptyIndex + 1);
   const detailLines = restLines;
+  const headlineParsed = headline ? parseConventionalHeadline(headline) : null;
+  const breaking = bodyBreaking || (_nullishCoalesce(_optionalChain([headlineParsed, 'optionalAccess', _ => _.breaking]), () => ( false)));
   return {
     headline,
     detailLines,
     prNumber,
     commitRef,
-    users
+    users,
+    breaking
   };
 }
 async function resolveLinks(repo, parsed, changesetCommit) {
@@ -178,7 +222,7 @@ function indentMarkdownBlock(lines, spaces) {
   }).join("\n");
 }
 function formatDetailBlock(detailLines) {
-  const trimmed = detailLines.join("\n").trim().split("\n").map((line) => line.trimRight());
+  const trimmed = detailLines.join("\n").trim().split("\n").map((line) => line.trimEnd());
   const hasFence = trimmed.some((line) => /^\s*```/.test(line));
   const isListLike = trimmed.some((line) => /^\s*(?:[-*+]\s+|\d+[.)]\s+)/.test(line));
   if (trimmed.length === 0) {
@@ -187,8 +231,11 @@ function formatDetailBlock(detailLines) {
   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");
+  const paragraphs = trimmed.join("\n").split(/\n\s*\n/).filter((chunk) => chunk.trim().length > 0);
+  const lines = paragraphs.flatMap(
+    (chunk) => chunk.split("\n").map((line) => line.trim()).filter(Boolean)
+  );
+  return lines.map((text) => `  - ${text}`).join("\n");
 }
 var changelogFunctions = {
   async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
@@ -217,10 +264,13 @@ var changelogFunctions = {
       parsedSummary.users,
       links.user
     );
-    const headlineText = parsedSummary.headline || "Miscellaneous improvements";
+    const { text: headlineText, breaking: headlineBreaking } = parsedSummary.headline ? formatHeadline(parsedSummary.headline) : { text: "Miscellaneous improvements", breaking: false };
+    const isBreaking = parsedSummary.breaking || headlineBreaking;
+    const breakingPrefix = isBreaking ? "\u26A0\uFE0F " : "";
+    const icon = isBreaking ? "\u{1F4A5}" : releaseTypeMap[resolvedType].icon;
     const mainLineParts = [
-      `- ${releaseTypeMap[resolvedType].icon}`,
-      `**${headlineText}**`
+      `- ${icon}`,
+      `${breakingPrefix}**${headlineText}**`
     ];
     if (links.pull) {
       mainLineParts.push(links.pull);
@@ -249,4 +299,6 @@ var { getDependencyReleaseLine, getReleaseLine } = changelogFunctions;
 
 
 
-exports.default = index_default; exports.getDependencyReleaseLine = getDependencyReleaseLine; exports.getReleaseLine = getReleaseLine;
+
+
+exports.default = index_default; exports.formatHeadline = formatHeadline; exports.getDependencyReleaseLine = getDependencyReleaseLine; exports.getReleaseLine = getReleaseLine; exports.parseConventionalHeadline = parseConventionalHeadline;

package/dist/index.d.cts

@@ -1,6 +1,17 @@
 import * as _changesets_types from '@changesets/types';
 import { ChangelogFunctions } from '@changesets/types';
 
+interface ConventionalHeadline {
+    type?: string;
+    scope?: string;
+    breaking: boolean;
+    description: string;
+}
+declare function parseConventionalHeadline(raw: string): ConventionalHeadline;
+declare function formatHeadline(raw: string): {
+    text: string;
+    breaking: boolean;
+};
 declare const changelogFunctions: ChangelogFunctions;
 
 declare const getDependencyReleaseLine: _changesets_types.GetDependencyReleaseLine;
@@ -8,4 +19,4 @@ declare const getReleaseLine: _changesets_types.GetReleaseLine;
 
 // @ts-ignore
 export = changelogFunctions;
-export { getDependencyReleaseLine, getReleaseLine };
+export { formatHeadline, getDependencyReleaseLine, getReleaseLine, parseConventionalHeadline };

package/dist/index.d.ts

@@ -1,9 +1,20 @@
 import * as _changesets_types from '@changesets/types';
 import { ChangelogFunctions } from '@changesets/types';
 
+interface ConventionalHeadline {
+    type?: string;
+    scope?: string;
+    breaking: boolean;
+    description: string;
+}
+declare function parseConventionalHeadline(raw: string): ConventionalHeadline;
+declare function formatHeadline(raw: string): {
+    text: string;
+    breaking: boolean;
+};
 declare const changelogFunctions: ChangelogFunctions;
 
 declare const getDependencyReleaseLine: _changesets_types.GetDependencyReleaseLine;
 declare const getReleaseLine: _changesets_types.GetReleaseLine;
 
-export { changelogFunctions as default, getDependencyReleaseLine, getReleaseLine };
+export { changelogFunctions as default, formatHeadline, getDependencyReleaseLine, getReleaseLine, parseConventionalHeadline };

package/dist/index.mjs

@@ -34,7 +34,7 @@ async function collectDependencyReferences(changesets, repo) {
       return links.commit;
     })
   );
-  return references.filter((link) => Boolean(link));
+  return [...new Set(references.filter((link) => Boolean(link)))];
 }
 function formatDependencyLine(references, dependenciesUpdated) {
   const count = dependenciesUpdated.length;
@@ -42,16 +42,50 @@ function formatDependencyLine(references, dependenciesUpdated) {
   if (count === 0) {
     return firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
   }
+  const dependencySummaries = dependenciesUpdated.map(
+    (dependency) => `\`${dependency.name}@${dependency.newVersion}\``
+  );
   if (count <= 3) {
-    const dependencySummaries = dependenciesUpdated.map(
-      (dependency) => `\`${dependency.name}@${dependency.newVersion}\``
-    );
-    const header = firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
+    const header2 = firstCommit ? `- \u{1F4E6} **Dependencies** ${firstCommit}` : "- \u{1F4E6} **Dependencies**";
     const details = `  \u2192 ${dependencySummaries.join(", ")}`;
-    return `${header}
+    return `${header2}
 ${details}`;
   }
-  return firstCommit ? `- \u{1F4E6} Updated ${count} dependencies ${firstCommit}` : `- \u{1F4E6} Updated ${count} dependencies`;
+  const header = firstCommit ? `- \u{1F4E6} Updated ${count} dependencies ${firstCommit}` : `- \u{1F4E6} Updated ${count} dependencies`;
+  const detailBlock = [
+    "  <details><summary>Details</summary>",
+    "",
+    `  ${dependencySummaries.join(", ")}`,
+    "",
+    "  </details>"
+  ].join("\n");
+  return `${header}
+${detailBlock}`;
+}
+function parseConventionalHeadline(raw) {
+  const match = raw.match(
+    /^(\w+)(?:\(([^)]*)\))?(!?):\s(.+)$/
+  );
+  if (!match) {
+    return { breaking: false, description: raw };
+  }
+  return {
+    type: match[1],
+    scope: match[2] || void 0,
+    breaking: match[3] === "!",
+    description: match[4].trim()
+  };
+}
+function formatHeadline(raw) {
+  const parsed = parseConventionalHeadline(raw);
+  if (!parsed.type) {
+    return { text: raw, breaking: parsed.breaking };
+  }
+  const scopeTag = parsed.scope ? `${parsed.scope}: ` : "";
+  return {
+    text: `${scopeTag}${parsed.description}`,
+    breaking: parsed.breaking
+  };
 }
 function normalizeUserMentions(users) {
   const normalized = users.map((user) => user.trim()).filter(Boolean).map((user) => user.startsWith("@") ? user : `@${user}`);
@@ -69,6 +103,7 @@ function normalizeUserMentions(users) {
 function extractSummaryMeta(summary) {
   let prNumber;
   let commitRef;
+  let breaking = false;
   const users = [];
   const contentLines = summary.split(/\r?\n/).filter((line) => {
     const trimmed = line.trim();
@@ -93,13 +128,17 @@ function extractSummaryMeta(summary) {
       users.push(userMatch[1].replace(/^@/, ""));
       return false;
     }
+    if (/^BREAKING[\s-]CHANGE:/i.test(withoutListMarker)) {
+      breaking = true;
+    }
     return true;
-  }).map((line) => line.trimRight());
+  }).map((line) => line.trimEnd());
   return {
     prNumber,
     commitRef,
     users,
-    contentLines
+    contentLines,
+    breaking
   };
 }
 function parseSummary(summary) {
@@ -107,7 +146,8 @@ function parseSummary(summary) {
     prNumber,
     commitRef,
     users,
-    contentLines
+    contentLines,
+    breaking: bodyBreaking
   } = extractSummaryMeta(summary);
   const nonEmptyIndex = contentLines.findIndex((line) => line.trim().length > 0);
   if (nonEmptyIndex === -1) {
@@ -116,7 +156,8 @@ function parseSummary(summary) {
       detailLines: [],
       prNumber,
       commitRef,
-      users
+      users,
+      breaking: bodyBreaking
     };
   }
   const firstContentLine = contentLines[nonEmptyIndex].trim();
@@ -124,12 +165,15 @@ function parseSummary(summary) {
   const headline = startsWithList ? "" : firstContentLine;
   const restLines = startsWithList ? contentLines.slice(nonEmptyIndex) : contentLines.slice(nonEmptyIndex + 1);
   const detailLines = restLines;
+  const headlineParsed = headline ? parseConventionalHeadline(headline) : null;
+  const breaking = bodyBreaking || (headlineParsed?.breaking ?? false);
   return {
     headline,
     detailLines,
     prNumber,
     commitRef,
-    users
+    users,
+    breaking
   };
 }
 async function resolveLinks(repo, parsed, changesetCommit) {
@@ -178,7 +222,7 @@ function indentMarkdownBlock(lines, spaces) {
   }).join("\n");
 }
 function formatDetailBlock(detailLines) {
-  const trimmed = detailLines.join("\n").trim().split("\n").map((line) => line.trimRight());
+  const trimmed = detailLines.join("\n").trim().split("\n").map((line) => line.trimEnd());
   const hasFence = trimmed.some((line) => /^\s*```/.test(line));
   const isListLike = trimmed.some((line) => /^\s*(?:[-*+]\s+|\d+[.)]\s+)/.test(line));
   if (trimmed.length === 0) {
@@ -187,8 +231,11 @@ function formatDetailBlock(detailLines) {
   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");
+  const paragraphs = trimmed.join("\n").split(/\n\s*\n/).filter((chunk) => chunk.trim().length > 0);
+  const lines = paragraphs.flatMap(
+    (chunk) => chunk.split("\n").map((line) => line.trim()).filter(Boolean)
+  );
+  return lines.map((text) => `  - ${text}`).join("\n");
 }
 var changelogFunctions = {
   async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
@@ -217,10 +264,13 @@ var changelogFunctions = {
       parsedSummary.users,
       links.user
     );
-    const headlineText = parsedSummary.headline || "Miscellaneous improvements";
+    const { text: headlineText, breaking: headlineBreaking } = parsedSummary.headline ? formatHeadline(parsedSummary.headline) : { text: "Miscellaneous improvements", breaking: false };
+    const isBreaking = parsedSummary.breaking || headlineBreaking;
+    const breakingPrefix = isBreaking ? "\u26A0\uFE0F " : "";
+    const icon = isBreaking ? "\u{1F4A5}" : releaseTypeMap[resolvedType].icon;
     const mainLineParts = [
-      `- ${releaseTypeMap[resolvedType].icon}`,
-      `**${headlineText}**`
+      `- ${icon}`,
+      `${breakingPrefix}**${headlineText}**`
     ];
     if (links.pull) {
       mainLineParts.push(links.pull);
@@ -247,6 +297,8 @@ var index_default = changelogFunctions;
 var { getDependencyReleaseLine, getReleaseLine } = changelogFunctions;
 export {
   index_default as default,
+  formatHeadline,
   getDependencyReleaseLine,
-  getReleaseLine
+  getReleaseLine,
+  parseConventionalHeadline
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/changelog-github",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Changesets GitHub changelog formatter for Icebreaker's dev-configs",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -36,7 +36,7 @@
   "dependencies": {
     "@changesets/get-github-info": "^0.7.0",
     "@changesets/types": "^6.1.0",
-    "dotenv": "^17.2.3"
+    "dotenv": "^17.2.4"
   },
   "devDependencies": {
     "@changesets/parse": "^0.4.2"