@modern-js/plugin-changeset 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @modern-js/plugin-changeset
 
+## 1.4.0
+
+### Minor Changes
+
+- 33cebd2: chore(plugin-i18n): merge `@modern-js/i18n-cli-language-detector` to `@modern-js/plugin-i18n`
+
+  chore(plugin-i18n): 合并 `@modern-js/i18n-cli-language-detector` 包到 `@modern-js/plugin-i18n` 包作为子路径
+
+### Patch Changes
+
+- 2e8ea92: feat: optimize release note
+
+  feat: 优化 Release Note 格式
+
+- Updated dependencies [33cebd2]
+  - @modern-js/plugin-i18n@1.3.0
+  - @modern-js/utils@1.7.12
+
+## 1.3.1
+
+### Patch Changes
+
+- 42741db: perf(plugin-changeset): optimize custom generator release note
+- Updated dependencies [a90bc96]
+  - @modern-js/utils@1.7.9
+
 ## 1.3.0
 
 ### Minor Changes

package/dist/js/modern/commands/release-note.js

@@ -1,4 +1,5 @@
 import path from 'path';
+import resolveFrom from 'resolve-from';
 import { fs, execa } from '@modern-js/utils';
 import readChangesets from '@changesets/read';
 export function getReleaseInfo(commit, commitObj) {
@@ -14,6 +15,24 @@ export function getReleaseInfo(commit, commitObj) {
 
   return commitObj;
 }
+
+function formatSummary(summary, pullRequestId) {
+  const [firstLine, ...futureLines] = summary.split('\n').map(l => l.trimRight());
+  let returnVal = firstLine;
+
+  if (futureLines.length > 0) {
+    if (pullRequestId) {
+      returnVal = `\n\n  ${returnVal}`;
+    } else {
+      returnVal = `\n  ${returnVal}`;
+    }
+
+    returnVal += `\n\n  ${futureLines.filter(l => Boolean(l)).map(l => l).join('\n\n')}`;
+  }
+
+  return returnVal;
+}
+
 export function getReleaseNoteLine(commit, customReleaseNoteFunction) {
   if (customReleaseNoteFunction !== null && customReleaseNoteFunction !== void 0 && customReleaseNoteFunction.getReleaseNoteLine) {
     return customReleaseNoteFunction.getReleaseNoteLine(commit);
@@ -22,17 +41,18 @@ export function getReleaseNoteLine(commit, customReleaseNoteFunction) {
   const {
     repository,
     pullRequestId,
-    summary,
-    author
+    summary
   } = commit;
 
   if (pullRequestId && repository) {
-    return `[[#${pullRequestId}](https://github.com/${repository}/pull/${pullRequestId})] ${summary}${author ? ` -- ${author}` : ''}\n`;
-  } else if (pullRequestId) {
-    return `[#${pullRequestId}] ${summary}${author ? ` -- ${author}` : ''}\n`;
-  } else {
-    return `${summary}${author ? ` -- ${author}` : ''}\n`;
+    return `- [#${pullRequestId}](https://github.com/${repository}/pull/${pullRequestId}) ${formatSummary(summary, pullRequestId)}\n`;
+  }
+
+  if (pullRequestId) {
+    return `#${pullRequestId} ${formatSummary(summary, pullRequestId)}\n`;
   }
+
+  return `${formatSummary(summary, pullRequestId)}\n`;
 }
 export async function genReleaseNote(options) {
   const cwd = process.cwd();
@@ -51,7 +71,19 @@ export async function genReleaseNote(options) {
   }
 
   if (custom) {
-    customReleaseNoteFunction = require(custom);
+    let possibleReleaseNoteFunc;
+    const releasenotePath = resolveFrom(cwd, custom);
+    possibleReleaseNoteFunc = require(releasenotePath);
+
+    if (possibleReleaseNoteFunc.default) {
+      possibleReleaseNoteFunc = possibleReleaseNoteFunc.default;
+    }
+
+    if (typeof possibleReleaseNoteFunc.getReleaseInfo === 'function' && typeof possibleReleaseNoteFunc.getReleaseNoteLine === 'function') {
+      customReleaseNoteFunction = possibleReleaseNoteFunc;
+    } else {
+      throw new Error('Could not resolve relesae note generation functions');
+    }
   }
 
   const changesets = await readChangesets(cwd);
@@ -81,7 +113,7 @@ export async function genReleaseNote(options) {
     };
 
     if ((_customReleaseNoteFun = customReleaseNoteFunction) !== null && _customReleaseNoteFun !== void 0 && _customReleaseNoteFun.getReleaseInfo) {
-      commitObj = customReleaseNoteFunction.getReleaseInfo(stdout, commitObj);
+      commitObj = await customReleaseNoteFunction.getReleaseInfo(stdout, commitObj);
     } else {
       commitObj = getReleaseInfo(stdout, commitObj);
     }
@@ -98,12 +130,20 @@ export async function genReleaseNote(options) {
   }
 
   if (features.length) {
-    console.info('Features:\n');
-    features.forEach(commit => console.info(getReleaseNoteLine(commit, customReleaseNoteFunction)));
+    console.info('## Features:\n');
+
+    for (const commit of features) {
+      const releaseNote = await getReleaseNoteLine(commit, customReleaseNoteFunction);
+      console.info(releaseNote);
+    }
   }
 
   if (bugFix.length) {
-    console.info('Bug Fix:\n');
-    bugFix.forEach(commit => console.info(getReleaseNoteLine(commit, customReleaseNoteFunction)));
+    console.info('## Bug Fix:\n');
+
+    for (const commit of bugFix) {
+      const relesaeNote = await getReleaseNoteLine(commit, customReleaseNoteFunction);
+      console.info(relesaeNote);
+    }
   }
 }

package/dist/js/modern/utils/language.js

@@ -1,4 +1,4 @@
-import { I18CLILanguageDetector } from '@modern-js/i18n-cli-language-detector';
+import { I18CLILanguageDetector } from '@modern-js/plugin-i18n/language-detector';
 export function getLocaleLanguage() {
   const detector = new I18CLILanguageDetector();
   return detector.detect();

package/dist/js/node/commands/release-note.js

@@ -9,6 +9,8 @@ exports.getReleaseNoteLine = getReleaseNoteLine;
 
 var _path = _interopRequireDefault(require("path"));
 
+var _resolveFrom = _interopRequireDefault(require("resolve-from"));
+
 var _utils = require("@modern-js/utils");
 
 var _read = _interopRequireDefault(require("@changesets/read"));
@@ -29,6 +31,23 @@ function getReleaseInfo(commit, commitObj) {
   return commitObj;
 }
 
+function formatSummary(summary, pullRequestId) {
+  const [firstLine, ...futureLines] = summary.split('\n').map(l => l.trimRight());
+  let returnVal = firstLine;
+
+  if (futureLines.length > 0) {
+    if (pullRequestId) {
+      returnVal = `\n\n  ${returnVal}`;
+    } else {
+      returnVal = `\n  ${returnVal}`;
+    }
+
+    returnVal += `\n\n  ${futureLines.filter(l => Boolean(l)).map(l => l).join('\n\n')}`;
+  }
+
+  return returnVal;
+}
+
 function getReleaseNoteLine(commit, customReleaseNoteFunction) {
   if (customReleaseNoteFunction !== null && customReleaseNoteFunction !== void 0 && customReleaseNoteFunction.getReleaseNoteLine) {
     return customReleaseNoteFunction.getReleaseNoteLine(commit);
@@ -37,17 +56,18 @@ function getReleaseNoteLine(commit, customReleaseNoteFunction) {
   const {
     repository,
     pullRequestId,
-    summary,
-    author
+    summary
   } = commit;
 
   if (pullRequestId && repository) {
-    return `[[#${pullRequestId}](https://github.com/${repository}/pull/${pullRequestId})] ${summary}${author ? ` -- ${author}` : ''}\n`;
-  } else if (pullRequestId) {
-    return `[#${pullRequestId}] ${summary}${author ? ` -- ${author}` : ''}\n`;
-  } else {
-    return `${summary}${author ? ` -- ${author}` : ''}\n`;
+    return `- [#${pullRequestId}](https://github.com/${repository}/pull/${pullRequestId}) ${formatSummary(summary, pullRequestId)}\n`;
+  }
+
+  if (pullRequestId) {
+    return `#${pullRequestId} ${formatSummary(summary, pullRequestId)}\n`;
   }
+
+  return `${formatSummary(summary, pullRequestId)}\n`;
 }
 
 async function genReleaseNote(options) {
@@ -67,7 +87,19 @@ async function genReleaseNote(options) {
   }
 
   if (custom) {
-    customReleaseNoteFunction = require(custom);
+    let possibleReleaseNoteFunc;
+    const releasenotePath = (0, _resolveFrom.default)(cwd, custom);
+    possibleReleaseNoteFunc = require(releasenotePath);
+
+    if (possibleReleaseNoteFunc.default) {
+      possibleReleaseNoteFunc = possibleReleaseNoteFunc.default;
+    }
+
+    if (typeof possibleReleaseNoteFunc.getReleaseInfo === 'function' && typeof possibleReleaseNoteFunc.getReleaseNoteLine === 'function') {
+      customReleaseNoteFunction = possibleReleaseNoteFunc;
+    } else {
+      throw new Error('Could not resolve relesae note generation functions');
+    }
   }
 
   const changesets = await (0, _read.default)(cwd);
@@ -97,7 +129,7 @@ async function genReleaseNote(options) {
     };
 
     if ((_customReleaseNoteFun = customReleaseNoteFunction) !== null && _customReleaseNoteFun !== void 0 && _customReleaseNoteFun.getReleaseInfo) {
-      commitObj = customReleaseNoteFunction.getReleaseInfo(stdout, commitObj);
+      commitObj = await customReleaseNoteFunction.getReleaseInfo(stdout, commitObj);
     } else {
       commitObj = getReleaseInfo(stdout, commitObj);
     }
@@ -114,12 +146,20 @@ async function genReleaseNote(options) {
   }
 
   if (features.length) {
-    console.info('Features:\n');
-    features.forEach(commit => console.info(getReleaseNoteLine(commit, customReleaseNoteFunction)));
+    console.info('## Features:\n');
+
+    for (const commit of features) {
+      const releaseNote = await getReleaseNoteLine(commit, customReleaseNoteFunction);
+      console.info(releaseNote);
+    }
   }
 
   if (bugFix.length) {
-    console.info('Bug Fix:\n');
-    bugFix.forEach(commit => console.info(getReleaseNoteLine(commit, customReleaseNoteFunction)));
+    console.info('## Bug Fix:\n');
+
+    for (const commit of bugFix) {
+      const relesaeNote = await getReleaseNoteLine(commit, customReleaseNoteFunction);
+      console.info(relesaeNote);
+    }
   }
 }

package/dist/js/node/utils/language.js

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getLocaleLanguage = getLocaleLanguage;
 
-var _i18nCliLanguageDetector = require("@modern-js/i18n-cli-language-detector");
+var _languageDetector = require("@modern-js/plugin-i18n/language-detector");
 
 function getLocaleLanguage() {
-  const detector = new _i18nCliLanguageDetector.I18CLILanguageDetector();
+  const detector = new _languageDetector.I18CLILanguageDetector();
   return detector.detect();
 }

package/dist/types/commands/release-note.d.ts

@@ -6,16 +6,17 @@ export interface Commit {
   author?: string;
   message: string;
   summary: string;
+  [key: string]: string | undefined;
 }
 interface ReleaseNoteOptions {
   repo?: string;
   custom?: string;
 }
 export declare type CustomReleaseNoteFunction = {
-  getReleaseInfo?: (commit: string, commitObj: Commit) => Commit;
-  getReleaseNoteLine?: (commit: Commit) => string;
+  getReleaseInfo?: (commit: string, commitObj: Commit) => Commit | Promise<Commit>;
+  getReleaseNoteLine?: (commit: Commit) => string | Promise<string>;
 } | undefined;
 export declare function getReleaseInfo(commit: string, commitObj: Commit): Commit;
-export declare function getReleaseNoteLine(commit: Commit, customReleaseNoteFunction?: CustomReleaseNoteFunction): string;
+export declare function getReleaseNoteLine(commit: Commit, customReleaseNoteFunction?: CustomReleaseNoteFunction): string | Promise<string>;
 export declare function genReleaseNote(options: ReleaseNoteOptions): Promise<void>;
 export {};

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.3.0",
+  "version": "1.4.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -36,13 +36,13 @@
     "@changesets/cli": "^2.23.0",
     "@changesets/git": "^1.3.2",
     "@changesets/read": "^0.5.5",
-    "@modern-js/i18n-cli-language-detector": "^1.2.4",
-    "@modern-js/plugin-i18n": "^1.2.7",
-    "@modern-js/utils": "^1.7.8",
-    "execa": "^5.1.1"
+    "@modern-js/plugin-i18n": "^1.3.0",
+    "@modern-js/utils": "^1.7.12",
+    "execa": "^5.1.1",
+    "resolve-from": "^5.0.0"
   },
   "devDependencies": {
-    "@modern-js/core": "1.12.1",
+    "@modern-js/core": "1.13.0",
     "@scripts/build": "0.0.0",
     "@types/jest": "^27",
     "@types/node": "^14",