@modern-js/plugin-changeset 2.21.2-alpha.1 → 2.22.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @modern-js/plugin-changeset
 
+## 2.22.0
+
+### Minor Changes
+
+- 7d1b96e: feat(changeset): optimize release note display
+
+  feat(changeset): 优化生成 Release Note 文案
+
+### Patch Changes
+
+- Updated dependencies [3d48836]
+- Updated dependencies [5050e8e]
+  - @modern-js/utils@2.22.0
+  - @modern-js/plugin-i18n@2.22.0
+
 ## 2.21.1
 
 ### Patch Changes

package/dist/cjs/commands/bump.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "bump", {
   enumerable: true,
-  get: () => bump
+  get: function() {
+    return bump;
+  }
 });
 const _utils = require("../utils");
 async function bump(options) {

package/dist/cjs/commands/change.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "change", {
   enumerable: true,
-  get: () => change
+  get: function() {
+    return change;
+  }
 });
 const _utils = require("@modern-js/utils");
 const _utils1 = require("../utils");

package/dist/cjs/commands/pre.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "pre", {
   enumerable: true,
-  get: () => pre
+  get: function() {
+    return pre;
+  }
 });
 const _utils = require("../utils");
 async function pre(type, tag = "next") {

package/dist/cjs/commands/release.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "release", {
   enumerable: true,
-  get: () => release
+  get: function() {
+    return release;
+  }
 });
 const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
 const _path = /* @__PURE__ */ _interop_require_default._(require("path"));

package/dist/cjs/commands/releaseNote.js

@@ -10,15 +10,33 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-  CommitType: () => CommitType,
-  ChangesTitle: () => ChangesTitle,
-  ChangesZhTitle: () => ChangesZhTitle,
-  CommitTypeTitle: () => CommitTypeTitle,
-  CommitTypeZhTitle: () => CommitTypeZhTitle,
-  getCommitType: () => getCommitType,
-  getReleaseInfo: () => getReleaseInfo,
-  getReleaseNoteLine: () => getReleaseNoteLine,
-  genReleaseNote: () => genReleaseNote
+  CommitType: function() {
+    return CommitType;
+  },
+  ChangesTitle: function() {
+    return ChangesTitle;
+  },
+  ChangesZhTitle: function() {
+    return ChangesZhTitle;
+  },
+  CommitTypeTitle: function() {
+    return CommitTypeTitle;
+  },
+  CommitTypeZhTitle: function() {
+    return CommitTypeZhTitle;
+  },
+  getCommitType: function() {
+    return getCommitType;
+  },
+  getReleaseInfo: function() {
+    return getReleaseInfo;
+  },
+  getReleaseNoteLine: function() {
+    return getReleaseNoteLine;
+  },
+  genReleaseNote: function() {
+    return genReleaseNote;
+  }
 });
 const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
 const _path = /* @__PURE__ */ _interop_require_default._(require("path"));
@@ -77,15 +95,15 @@ function getReleaseInfo(commit, commitObj) {
 }
 function getReleaseNoteLine(commit, customReleaseNoteFunction, lang = "en") {
   if (customReleaseNoteFunction === null || customReleaseNoteFunction === void 0 ? void 0 : customReleaseNoteFunction.getReleaseNoteLine) {
-    return customReleaseNoteFunction.getReleaseNoteLine(commit);
+    return customReleaseNoteFunction.getReleaseNoteLine(commit, lang);
   }
   const { repository, pullRequestId, summary, summary_zh, author } = commit;
-  const pullRequest = pullRequestId ? `https://github.com/${repository}/pull/${pullRequestId}` : "";
+  const pullRequest = pullRequestId && repository ? `https://github.com/${repository}/pull/${pullRequestId}` : "";
   if (lang === "en") {
-    return `- ${summary} by @${author}${pullRequest ? ` in ${pullRequest}` : ""} 
+    return `- ${summary}${author ? ` by @${author}` : ""}${pullRequest ? ` in ${pullRequest}` : ""}
 `;
   }
-  return `- ${summary_zh} 由 @${author} 实现${pullRequest ? `， 详情可查看 ${pullRequest}` : ""} 
+  return `- ${summary_zh}${author ? ` 由 @${author} 实现` : ""}${pullRequest ? `， 详情可查看 ${pullRequest}` : ""}
 `;
 }
 async function genReleaseNote(options) {

package/dist/cjs/commands/status.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "status", {
   enumerable: true,
-  get: () => status
+  get: function() {
+    return status;
+  }
 });
 const _utils = require("../utils");
 async function status(options) {

package/dist/cjs/index.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "default", {
   enumerable: true,
-  get: () => _default
+  get: function() {
+    return _default;
+  }
 });
 const _export_star = require("@swc/helpers/_/_export_star");
 const _languagedetector = require("@modern-js/plugin-i18n/language-detector");

package/dist/cjs/locale/en.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "EN_LOCALE", {
   enumerable: true,
-  get: () => EN_LOCALE
+  get: function() {
+    return EN_LOCALE;
+  }
 });
 const EN_LOCALE = {
   command: {

package/dist/cjs/locale/index.js

@@ -10,8 +10,12 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-  i18n: () => i18n,
-  localeKeys: () => localeKeys
+  i18n: function() {
+    return i18n;
+  },
+  localeKeys: function() {
+    return localeKeys;
+  }
 });
 const _plugini18n = require("@modern-js/plugin-i18n");
 const _zh = require("./zh");

package/dist/cjs/locale/zh.js

@@ -4,7 +4,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 Object.defineProperty(exports, "ZH_LOCALE", {
   enumerable: true,
-  get: () => ZH_LOCALE
+  get: function() {
+    return ZH_LOCALE;
+  }
 });
 const ZH_LOCALE = {
   command: {

package/dist/cjs/utils/changeset.js

@@ -10,8 +10,12 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-  CHANGESET_PATH: () => CHANGESET_PATH,
-  execaWithStreamLog: () => execaWithStreamLog
+  CHANGESET_PATH: function() {
+    return CHANGESET_PATH;
+  },
+  execaWithStreamLog: function() {
+    return execaWithStreamLog;
+  }
 });
 const _utils = require("@modern-js/utils");
 const CHANGESET_PATH = require.resolve("@changesets/cli");

package/dist/esm/commands/releaseNote.js

@@ -54,15 +54,15 @@ export function getReleaseInfo(commit, commitObj) {
 }
 export function getReleaseNoteLine(commit, customReleaseNoteFunction, lang = "en") {
   if (customReleaseNoteFunction === null || customReleaseNoteFunction === void 0 ? void 0 : customReleaseNoteFunction.getReleaseNoteLine) {
-    return customReleaseNoteFunction.getReleaseNoteLine(commit);
+    return customReleaseNoteFunction.getReleaseNoteLine(commit, lang);
   }
   const { repository, pullRequestId, summary, summary_zh, author } = commit;
-  const pullRequest = pullRequestId ? `https://github.com/${repository}/pull/${pullRequestId}` : "";
+  const pullRequest = pullRequestId && repository ? `https://github.com/${repository}/pull/${pullRequestId}` : "";
   if (lang === "en") {
-    return `- ${summary} by @${author}${pullRequest ? ` in ${pullRequest}` : ""} 
+    return `- ${summary}${author ? ` by @${author}` : ""}${pullRequest ? ` in ${pullRequest}` : ""}
 `;
   }
-  return `- ${summary_zh} 由 @${author} 实现${pullRequest ? `， 详情可查看 ${pullRequest}` : ""} 
+  return `- ${summary_zh}${author ? ` 由 @${author} 实现` : ""}${pullRequest ? `， 详情可查看 ${pullRequest}` : ""}
 `;
 }
 export async function genReleaseNote(options) {

package/dist/types/commands/releaseNote.d.ts

@@ -27,7 +27,7 @@ interface ReleaseNoteOptions {
 }
 export type CustomReleaseNoteFunction = {
   getReleaseInfo?: (commit: string, commitObj: Commit) => Commit | Promise<Commit>;
-  getReleaseNoteLine?: (commit: Commit) => string | Promise<string>;
+  getReleaseNoteLine?: (commit: Commit, lang?: 'en' | 'zh') => string | Promise<string>;
 } | undefined;
 export declare const ChangesTitle = "What's Changed";
 export declare const ChangesZhTitle = "\u66F4\u65B0\u5185\u5BB9";

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.21.2-alpha.1",
+  "version": "2.22.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -49,19 +49,19 @@
     "@changesets/cli": "^2.26.0",
     "@changesets/git": "^1.3.2",
     "@changesets/read": "^0.5.5",
-    "@modern-js/plugin-i18n": "2.21.1",
-    "@modern-js/utils": "2.21.1",
     "resolve-from": "^5.0.0",
-    "@swc/helpers": "0.5.1"
+    "@swc/helpers": "0.5.1",
+    "@modern-js/plugin-i18n": "2.22.0",
+    "@modern-js/utils": "2.22.0"
   },
   "devDependencies": {
-    "@modern-js/core": "2.21.1",
-    "@scripts/build": "2.21.1",
     "@types/jest": "^29",
     "@types/node": "^14",
     "typescript": "^5",
     "jest": "^29",
-    "@scripts/jest-config": "2.21.1"
+    "@modern-js/core": "2.22.0",
+    "@scripts/jest-config": "2.22.0",
+    "@scripts/build": "2.22.0"
   },
   "sideEffects": false,
   "publishConfig": {

package/dist/js/modern/commands/bump.js

@@ -1,66 +0,0 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-import { CHANGESET_PATH, execaWithStreamLog } from "../utils";
-function bump(options) {
-  return __async(this, null, function* () {
-    const { snapshot, canary, preid, ignore } = options;
-    const params = [CHANGESET_PATH, "version"];
-    if (snapshot) {
-      params.push("--snapshot");
-      if (typeof snapshot === "string") {
-        params.push(snapshot);
-      }
-    }
-    if (ignore) {
-      ignore.forEach((pkg) => {
-        params.push("--ignore");
-        params.push(pkg);
-      });
-    }
-    if (canary) {
-      yield execaWithStreamLog(process.execPath, [
-        CHANGESET_PATH,
-        "pre",
-        "enter",
-        preid || "next"
-      ]);
-      try {
-        yield execaWithStreamLog(process.execPath, params);
-        yield execaWithStreamLog(process.execPath, [
-          CHANGESET_PATH,
-          "pre",
-          "exit"
-        ]);
-      } catch (e) {
-        yield execaWithStreamLog(process.execPath, [
-          CHANGESET_PATH,
-          "pre",
-          "exit"
-        ]);
-      }
-    } else {
-      yield execaWithStreamLog(process.execPath, params);
-    }
-  });
-}
-export {
-  bump
-};

package/dist/js/modern/commands/change.js

@@ -1,57 +0,0 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-import {
-  isMonorepo,
-  getMonorepoPackages,
-  getPackageManager,
-  logger
-} from "@modern-js/utils";
-import { CHANGESET_PATH, execaWithStreamLog } from "../utils";
-import { i18n, localeKeys } from "../locale";
-function change(options) {
-  return __async(this, null, function* () {
-    const appDir = process.cwd();
-    if (isMonorepo(appDir)) {
-      const packages = getMonorepoPackages(appDir);
-      if (packages.length === 0) {
-        const packageManager = yield getPackageManager(appDir);
-        logger.warn(
-          i18n.t(localeKeys.command.change.no_packages, {
-            packageManager: packageManager === "yarn" ? "yarn" : `${packageManager} run`
-          })
-        );
-        return;
-      }
-    }
-    const { empty, open } = options;
-    const params = [CHANGESET_PATH, "add"];
-    if (empty) {
-      params.push("--empty");
-    }
-    if (open) {
-      params.push("--open");
-    }
-    yield execaWithStreamLog(process.execPath, params);
-  });
-}
-export {
-  change
-};

package/dist/js/modern/commands/index.js

@@ -1,6 +0,0 @@
-export * from "./change";
-export * from "./bump";
-export * from "./pre";
-export * from "./release";
-export * from "./status";
-export * from "./release-note";

package/dist/js/modern/commands/pre.js

@@ -1,33 +0,0 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-import { CHANGESET_PATH, execaWithStreamLog } from "../utils";
-function pre(type, tag = "next") {
-  return __async(this, null, function* () {
-    const params = [CHANGESET_PATH, "pre", type];
-    if (type === "enter") {
-      params.push(tag);
-    }
-    yield execaWithStreamLog(process.execPath, params);
-  });
-}
-export {
-  pre
-};

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

@@ -1,162 +0,0 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-import path from "path";
-import resolveFrom from "resolve-from";
-import { fs, execa } from "@modern-js/utils";
-import readChangesets from "@changesets/read";
-function getReleaseInfo(commit, commitObj) {
-  const commitRegex = /(.*)\(#(\d*)\)/;
-  const [, message, author] = commit.split("--");
-  commitObj.author = author;
-  if ((message || commitObj.summary).match(commitRegex)) {
-    const [, messageShort, pullRequestId] = (message || commitObj.summary).match(commitRegex);
-    commitObj.pullRequestId = pullRequestId;
-    commitObj.message = messageShort.trim();
-  }
-  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 = `
-
-  ${returnVal}`;
-    } else {
-      returnVal = `
-  ${returnVal}`;
-    }
-    returnVal += `
-
-  ${futureLines.filter((l) => Boolean(l)).map((l) => l).join("\n\n")}`;
-  }
-  return returnVal;
-}
-function getReleaseNoteLine(commit, customReleaseNoteFunction) {
-  if (customReleaseNoteFunction == null ? void 0 : customReleaseNoteFunction.getReleaseNoteLine) {
-    return customReleaseNoteFunction.getReleaseNoteLine(commit);
-  }
-  const { repository, pullRequestId, summary } = commit;
-  if (pullRequestId && repository) {
-    return `- [#${pullRequestId}](https://github.com/${repository}/pull/${pullRequestId}) ${formatSummary(
-      summary,
-      pullRequestId
-    )}
-`;
-  }
-  if (pullRequestId) {
-    return `#${pullRequestId} ${formatSummary(summary, pullRequestId)}
-`;
-  }
-  return `${formatSummary(summary, pullRequestId)}
-`;
-}
-function genReleaseNote(options) {
-  return __async(this, null, function* () {
-    const cwd = process.cwd();
-    const { repo, custom } = options;
-    let repository = repo;
-    let customReleaseNoteFunction;
-    if (!repo) {
-      const pkg = yield fs.readJSON(path.join(cwd, "package.json"));
-      ({ repository } = pkg);
-    }
-    if (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 = yield readChangesets(cwd);
-    if (changesets.length === 0) {
-      console.warn("No unreleased changesets found.");
-      process.exit(1);
-    }
-    const features = [];
-    const bugFix = [];
-    for (const changeset of changesets) {
-      const { stdout } = yield execa("git", [
-        "log",
-        "--pretty=format:%h--%s--%an",
-        `.changeset/${changeset.id}.md`
-      ]);
-      const [id, message] = stdout.split("--");
-      let commitObj = {
-        id,
-        type: (message || changeset.summary).startsWith("fix") ? "fix" : "feature",
-        repository,
-        message: (message || changeset.summary).trim(),
-        summary: changeset.summary
-      };
-      if (customReleaseNoteFunction == null ? void 0 : customReleaseNoteFunction.getReleaseInfo) {
-        commitObj = yield customReleaseNoteFunction.getReleaseInfo(
-          stdout,
-          commitObj
-        );
-      } else {
-        commitObj = getReleaseInfo(stdout, commitObj);
-      }
-      if (commitObj.type === "fix") {
-        bugFix.push(commitObj);
-      } else {
-        features.push(commitObj);
-      }
-    }
-    if (!features.length && !bugFix.length) {
-      console.warn(
-        "no release note found, you can run `pnpm run add` to add changeset"
-      );
-    }
-    if (features.length) {
-      console.info("## Features:\n");
-      for (const commit of features) {
-        const releaseNote = yield getReleaseNoteLine(
-          commit,
-          customReleaseNoteFunction
-        );
-        console.info(releaseNote);
-      }
-    }
-    if (bugFix.length) {
-      console.info("## Bug Fix:\n");
-      for (const commit of bugFix) {
-        const relesaeNote = yield getReleaseNoteLine(
-          commit,
-          customReleaseNoteFunction
-        );
-        console.info(relesaeNote);
-      }
-    }
-  });
-}
-export {
-  genReleaseNote,
-  getReleaseInfo,
-  getReleaseNoteLine
-};

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

@@ -1,76 +0,0 @@
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-import path from "path";
-import {
-  getPackageManager,
-  isMonorepo,
-  fs,
-  getPnpmVersion
-} from "@modern-js/utils";
-import { tag as gitTag } from "@changesets/git";
-import { CHANGESET_PATH, execaWithStreamLog } from "../utils";
-function release(options) {
-  return __async(this, null, function* () {
-    const appDir = process.cwd();
-    const packageManager = yield getPackageManager(process.cwd());
-    const params = ["publish"];
-    const { tag, otp, ignoreScripts, gitChecks } = options;
-    if (tag) {
-      params.push("--tag");
-      params.push(tag);
-    }
-    if (otp) {
-      params.push("--otp");
-      params.push(otp);
-    }
-    if (!isMonorepo(appDir) || packageManager === "yarn" || packageManager === "npm") {
-      yield execaWithStreamLog(process.execPath, [CHANGESET_PATH, ...params]);
-      return;
-    }
-    params.push("-r");
-    params.push("--filter");
-    const pnpmVersion = yield getPnpmVersion();
-    if (pnpmVersion.startsWith("6")) {
-      params.push("./packages/");
-    } else {
-      params.push("{./packages/**}");
-    }
-    params.push("--report-summary");
-    if (ignoreScripts) {
-      params.push("--ignore-scripts");
-    }
-    if (!gitChecks) {
-      params.push("--no-git-checks");
-    }
-    yield execaWithStreamLog(packageManager, params);
-    const pnpmPublishSummaryFile = path.join(appDir, "pnpm-publish-summary.json");
-    const publishInfo = yield fs.readJSON(pnpmPublishSummaryFile, "utf-8");
-    yield Promise.all(
-      (publishInfo.publishedPackages || []).map(
-        (pkg) => gitTag(`${pkg.name}@${pkg.version}`, appDir)
-      )
-    );
-    yield fs.remove(pnpmPublishSummaryFile);
-  });
-}
-export {
-  release
-};