@icebreakers/changelog-github 0.2.0 → 0.2.1

package/README.md

@@ -46,7 +46,7 @@ All other behaviours (tuple arguments, required `repo` option, rendered layout)
 
 Leverage the summary tags to control the metadata the formatter displays:
 
-```
+```text
 pr: #42
 commit: 1234567890abcdef1234567890abcdef12345678
 author: @octocat
@@ -59,7 +59,7 @@ Add optional `tailwind-config` flag to the lint preset
 
 The rendered changelog entry becomes:
 
-```
+```md
 - ✨ **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

package/README.zh.md

@@ -44,7 +44,7 @@ pnpm add -D @changesets/cli @icebreakers/changelog-github
 
 可以借助摘要指令精准控制展示的元数据：
 
-```
+```text
 pr: #42
 commit: 1234567890abcdef1234567890abcdef12345678
 author: @octocat
@@ -57,7 +57,7 @@ author: @octocat
 
 最终 changelog 会渲染为：
 
-```
+```md
 - ✨ **为 lint preset 新增可选的 `tailwind-config` 配置项** [#42] [`1234567`](https://github.com/org/repo/commit/1234567890abcdef1234567890abcdef12345678) by @octocat
   - 接受相对路径指向 `tailwind.config.ts`
   - 未设置时默认读取工作区根目录

package/dist/index.cjs

@@ -15,7 +15,7 @@ function resolveReleaseType(type) {
   return "none";
 }
 function assertRepo(options) {
-  if (!options || !options.repo) {
+  if (!options || typeof options["repo"] !== "string" || options["repo"].trim().length === 0) {
     throw new Error(
       'Please provide a repo to this changelog generator like this:\n"changelog": ["@icebreakers/changelog-github", { "repo": "org/repo" }]'
     );
@@ -69,11 +69,14 @@ function parseConventionalHeadline(raw) {
   if (!match) {
     return { breaking: false, description: raw };
   }
+  const type = match[1];
+  const scope = match[2] || void 0;
+  const description = (_nullishCoalesce(match[4], () => ( raw))).trim();
   return {
-    type: match[1],
-    scope: match[2] || void 0,
+    type,
+    scope,
     breaking: match[3] === "!",
-    description: match[4].trim()
+    description
   };
 }
 function formatHeadline(raw) {
@@ -93,12 +96,12 @@ function normalizeUserMentions(users) {
     return "";
   }
   if (normalized.length === 1) {
-    return normalized[0];
+    return _nullishCoalesce(normalized[0], () => ( ""));
   }
   if (normalized.length === 2) {
-    return `${normalized[0]} and ${normalized[1]}`;
+    return `${_nullishCoalesce(normalized[0], () => ( ""))} and ${_nullishCoalesce(normalized[1], () => ( ""))}`;
   }
-  return `${normalized.slice(0, -1).join(", ")}, and ${normalized.at(-1)}`;
+  return `${normalized.slice(0, -1).join(", ")}, and ${_nullishCoalesce(normalized.at(-1), () => ( ""))}`;
 }
 function extractSummaryMeta(summary) {
   let prNumber;
@@ -112,7 +115,7 @@ function extractSummaryMeta(summary) {
       /^(?:pr|pull|pull\s*request):\s*#?(\d+)\s*$/i
     );
     if (prMatch) {
-      const num = Number(prMatch[1]);
+      const num = Number(_nullishCoalesce(prMatch[1], () => ( Number.NaN)));
       if (!Number.isNaN(num)) {
         prNumber = num;
       }
@@ -125,7 +128,10 @@ function extractSummaryMeta(summary) {
     }
     const userMatch = withoutListMarker.match(/^(?:author|user):\s*(\S+)\s*$/i);
     if (userMatch) {
-      users.push(userMatch[1].replace(/^@/, ""));
+      const user = userMatch[1];
+      if (user) {
+        users.push(user.replace(/^@/, ""));
+      }
       return false;
     }
     if (/^BREAKING[\s-]CHANGE:/i.test(withoutListMarker)) {
@@ -134,8 +140,8 @@ function extractSummaryMeta(summary) {
     return true;
   }).map((line) => line.trimEnd());
   return {
-    prNumber,
-    commitRef,
+    ...prNumber !== void 0 ? { prNumber } : {},
+    ...commitRef !== void 0 ? { commitRef } : {},
     users,
     contentLines,
     breaking
@@ -154,24 +160,24 @@ function parseSummary(summary) {
     return {
       headline: "",
       detailLines: [],
-      prNumber,
-      commitRef,
+      ...prNumber !== void 0 ? { prNumber } : {},
+      ...commitRef !== void 0 ? { commitRef } : {},
       users,
       breaking: bodyBreaking
     };
   }
-  const firstContentLine = contentLines[nonEmptyIndex].trim();
+  const firstContentLine = _nullishCoalesce(_optionalChain([contentLines, 'access', _ => _[nonEmptyIndex], 'optionalAccess', _2 => _2.trim, 'call', _3 => _3()]), () => ( ""));
   const startsWithList = /^(?:[-*+]\s+|\d+[.)]\s+)/.test(firstContentLine);
   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)));
+  const breaking = bodyBreaking || (_nullishCoalesce(_optionalChain([headlineParsed, 'optionalAccess', _4 => _4.breaking]), () => ( false)));
   return {
     headline,
     detailLines,
-    prNumber,
-    commitRef,
+    ...prNumber !== void 0 ? { prNumber } : {},
+    ...commitRef !== void 0 ? { commitRef } : {},
     users,
     breaking
   };
@@ -208,7 +214,8 @@ function buildUserMentions(users, fallbackUser) {
   }
   if (fallbackUser) {
     const match = fallbackUser.match(/@([^\]]+)/);
-    return match ? normalizeUserMentions([match[1]]) : "";
+    const matchedUser = _optionalChain([match, 'optionalAccess', _5 => _5[1]]);
+    return matchedUser ? normalizeUserMentions([matchedUser]) : "";
   }
   return "";
 }
@@ -240,7 +247,7 @@ function formatDetailBlock(detailLines) {
 var changelogFunctions = {
   async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
     assertRepo(options);
-    const { repo } = options;
+    const repo = options.repo;
     if (dependenciesUpdated.length === 0) {
       return "";
     }
@@ -252,7 +259,7 @@ var changelogFunctions = {
   },
   async getReleaseLine(changeset, type, options) {
     assertRepo(options);
-    const { repo } = options;
+    const repo = options.repo;
     const parsedSummary = parseSummary(changeset.summary);
     const resolvedType = resolveReleaseType(type);
     const links = await resolveLinks(

package/dist/index.d.cts

@@ -2,8 +2,8 @@ import * as _changesets_types from '@changesets/types';
 import { ChangelogFunctions } from '@changesets/types';
 
 interface ConventionalHeadline {
-    type?: string;
-    scope?: string;
+    type?: string | undefined;
+    scope?: string | undefined;
     breaking: boolean;
     description: string;
 }

package/dist/index.d.ts

@@ -2,8 +2,8 @@ import * as _changesets_types from '@changesets/types';
 import { ChangelogFunctions } from '@changesets/types';
 
 interface ConventionalHeadline {
-    type?: string;
-    scope?: string;
+    type?: string | undefined;
+    scope?: string | undefined;
     breaking: boolean;
     description: string;
 }

package/dist/index.mjs

@@ -15,7 +15,7 @@ function resolveReleaseType(type) {
   return "none";
 }
 function assertRepo(options) {
-  if (!options || !options.repo) {
+  if (!options || typeof options["repo"] !== "string" || options["repo"].trim().length === 0) {
     throw new Error(
       'Please provide a repo to this changelog generator like this:\n"changelog": ["@icebreakers/changelog-github", { "repo": "org/repo" }]'
     );
@@ -69,11 +69,14 @@ function parseConventionalHeadline(raw) {
   if (!match) {
     return { breaking: false, description: raw };
   }
+  const type = match[1];
+  const scope = match[2] || void 0;
+  const description = (match[4] ?? raw).trim();
   return {
-    type: match[1],
-    scope: match[2] || void 0,
+    type,
+    scope,
     breaking: match[3] === "!",
-    description: match[4].trim()
+    description
   };
 }
 function formatHeadline(raw) {
@@ -93,12 +96,12 @@ function normalizeUserMentions(users) {
     return "";
   }
   if (normalized.length === 1) {
-    return normalized[0];
+    return normalized[0] ?? "";
   }
   if (normalized.length === 2) {
-    return `${normalized[0]} and ${normalized[1]}`;
+    return `${normalized[0] ?? ""} and ${normalized[1] ?? ""}`;
   }
-  return `${normalized.slice(0, -1).join(", ")}, and ${normalized.at(-1)}`;
+  return `${normalized.slice(0, -1).join(", ")}, and ${normalized.at(-1) ?? ""}`;
 }
 function extractSummaryMeta(summary) {
   let prNumber;
@@ -112,7 +115,7 @@ function extractSummaryMeta(summary) {
       /^(?:pr|pull|pull\s*request):\s*#?(\d+)\s*$/i
     );
     if (prMatch) {
-      const num = Number(prMatch[1]);
+      const num = Number(prMatch[1] ?? Number.NaN);
       if (!Number.isNaN(num)) {
         prNumber = num;
       }
@@ -125,7 +128,10 @@ function extractSummaryMeta(summary) {
     }
     const userMatch = withoutListMarker.match(/^(?:author|user):\s*(\S+)\s*$/i);
     if (userMatch) {
-      users.push(userMatch[1].replace(/^@/, ""));
+      const user = userMatch[1];
+      if (user) {
+        users.push(user.replace(/^@/, ""));
+      }
       return false;
     }
     if (/^BREAKING[\s-]CHANGE:/i.test(withoutListMarker)) {
@@ -134,8 +140,8 @@ function extractSummaryMeta(summary) {
     return true;
   }).map((line) => line.trimEnd());
   return {
-    prNumber,
-    commitRef,
+    ...prNumber !== void 0 ? { prNumber } : {},
+    ...commitRef !== void 0 ? { commitRef } : {},
     users,
     contentLines,
     breaking
@@ -154,13 +160,13 @@ function parseSummary(summary) {
     return {
       headline: "",
       detailLines: [],
-      prNumber,
-      commitRef,
+      ...prNumber !== void 0 ? { prNumber } : {},
+      ...commitRef !== void 0 ? { commitRef } : {},
       users,
       breaking: bodyBreaking
     };
   }
-  const firstContentLine = contentLines[nonEmptyIndex].trim();
+  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);
@@ -170,8 +176,8 @@ function parseSummary(summary) {
   return {
     headline,
     detailLines,
-    prNumber,
-    commitRef,
+    ...prNumber !== void 0 ? { prNumber } : {},
+    ...commitRef !== void 0 ? { commitRef } : {},
     users,
     breaking
   };
@@ -208,7 +214,8 @@ function buildUserMentions(users, fallbackUser) {
   }
   if (fallbackUser) {
     const match = fallbackUser.match(/@([^\]]+)/);
-    return match ? normalizeUserMentions([match[1]]) : "";
+    const matchedUser = match?.[1];
+    return matchedUser ? normalizeUserMentions([matchedUser]) : "";
   }
   return "";
 }
@@ -240,7 +247,7 @@ function formatDetailBlock(detailLines) {
 var changelogFunctions = {
   async getDependencyReleaseLine(changesets, dependenciesUpdated, options) {
     assertRepo(options);
-    const { repo } = options;
+    const repo = options.repo;
     if (dependenciesUpdated.length === 0) {
       return "";
     }
@@ -252,7 +259,7 @@ var changelogFunctions = {
   },
   async getReleaseLine(changeset, type, options) {
     assertRepo(options);
-    const { repo } = options;
+    const repo = options.repo;
     const parsedSummary = parseSummary(changeset.summary);
     const resolvedType = resolveReleaseType(type);
     const links = await resolveLinks(

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/changelog-github",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Changesets GitHub changelog formatter for Icebreaker's dev-configs",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -34,12 +34,12 @@
     "dist"
   ],
   "dependencies": {
-    "@changesets/get-github-info": "^0.7.0",
+    "@changesets/get-github-info": "^0.8.0",
     "@changesets/types": "^6.1.0",
-    "dotenv": "^17.2.4"
+    "dotenv": "^17.3.1"
   },
   "devDependencies": {
-    "@changesets/parse": "^0.4.2"
+    "@changesets/parse": "^0.4.3"
   },
   "scripts": {
     "stub": "unbuild --stub",
@@ -49,6 +49,7 @@
     "test:dev": "vitest",
     "release": "pnpm publish",
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint:fix": "eslint . --fix",
+    "typecheck": "tsc --noEmit"
   }
 }