@livekit/changesets-changelog-github 0.0.1

package/dist/index.js

@@ -0,0 +1,114 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+var import_dotenv = require("dotenv");
+var import_get_github_info = require("@changesets/get-github-info");
+(0, import_dotenv.config)();
+var changelogFunctions = {
+  getDependencyReleaseLine: async (changesets, dependenciesUpdated, options) => {
+    if (!options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+      );
+    }
+    if (dependenciesUpdated.length === 0)
+      return "";
+    const changesetLink = `- Updated dependencies [${(await Promise.all(
+      changesets.map(async (cs) => {
+        if (cs.commit) {
+          let { links } = await (0, import_get_github_info.getInfo)({
+            repo: options.repo,
+            commit: cs.commit
+          });
+          return links.commit;
+        }
+      })
+    )).filter((_) => _).join(", ")}]:`;
+    const updatedDepenenciesList = dependenciesUpdated.map(
+      (dependency) => `  - ${dependency.name}@${dependency.newVersion}`
+    );
+    return [changesetLink, ...updatedDepenenciesList].join("\n");
+  },
+  getReleaseLine: async (changeset, type, options) => {
+    if (!options || !options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+      );
+    }
+    let prFromSummary;
+    let commitFromSummary;
+    let usersFromSummary = [];
+    const replacedChangelog = changeset.summary.replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+      let num = Number(pr);
+      if (!isNaN(num))
+        prFromSummary = num;
+      return "";
+    }).replace(/^\s*commit:\s*([^\s]+)/im, (_, commit) => {
+      commitFromSummary = commit;
+      return "";
+    }).replace(/^\s*(?:author|user):\s*@?([^\s]+)/gim, (_, user) => {
+      usersFromSummary.push(user);
+      return "";
+    }).trim();
+    const [firstLine, ...futureLines] = replacedChangelog.split("\n").map((l) => l.trimRight());
+    const links = await (async () => {
+      if (prFromSummary !== void 0) {
+        let { links: links2 } = await (0, import_get_github_info.getInfoFromPullRequest)({
+          repo: options.repo,
+          pull: prFromSummary
+        });
+        if (commitFromSummary) {
+          links2 = {
+            ...links2,
+            commit: `[\`${commitFromSummary}\`](https://github.com/${options.repo}/commit/${commitFromSummary})`
+          };
+        }
+        return links2;
+      }
+      const commitToFetchFrom = commitFromSummary || changeset.commit;
+      if (commitToFetchFrom) {
+        let { links: links2 } = await (0, import_get_github_info.getInfo)({
+          repo: options.repo,
+          commit: commitToFetchFrom
+        });
+        return links2;
+      }
+      return {
+        commit: null,
+        pull: null,
+        user: null
+      };
+    })();
+    const users = usersFromSummary.length ? usersFromSummary.map((userFromSummary) => `@${userFromSummary}`).join(", ") : links.user;
+    const prefix = links.pull ? `${links.pull} -` : links.commit ? `${links.commit} -` : "";
+    const suffix = users === null ? "" : `(${users})`;
+    return `
+
+- ${prefix} ${firstLine} ${suffix}
+${futureLines.map((l) => `  ${l}`).join("\n")}`;
+  }
+};
+var src_default = changelogFunctions;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});

package/dist/index.mjs

@@ -0,0 +1,92 @@
+// src/index.ts
+import { config } from "dotenv";
+import { getInfo, getInfoFromPullRequest } from "@changesets/get-github-info";
+config();
+var changelogFunctions = {
+  getDependencyReleaseLine: async (changesets, dependenciesUpdated, options) => {
+    if (!options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+      );
+    }
+    if (dependenciesUpdated.length === 0)
+      return "";
+    const changesetLink = `- Updated dependencies [${(await Promise.all(
+      changesets.map(async (cs) => {
+        if (cs.commit) {
+          let { links } = await getInfo({
+            repo: options.repo,
+            commit: cs.commit
+          });
+          return links.commit;
+        }
+      })
+    )).filter((_) => _).join(", ")}]:`;
+    const updatedDepenenciesList = dependenciesUpdated.map(
+      (dependency) => `  - ${dependency.name}@${dependency.newVersion}`
+    );
+    return [changesetLink, ...updatedDepenenciesList].join("\n");
+  },
+  getReleaseLine: async (changeset, type, options) => {
+    if (!options || !options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+      );
+    }
+    let prFromSummary;
+    let commitFromSummary;
+    let usersFromSummary = [];
+    const replacedChangelog = changeset.summary.replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+      let num = Number(pr);
+      if (!isNaN(num))
+        prFromSummary = num;
+      return "";
+    }).replace(/^\s*commit:\s*([^\s]+)/im, (_, commit) => {
+      commitFromSummary = commit;
+      return "";
+    }).replace(/^\s*(?:author|user):\s*@?([^\s]+)/gim, (_, user) => {
+      usersFromSummary.push(user);
+      return "";
+    }).trim();
+    const [firstLine, ...futureLines] = replacedChangelog.split("\n").map((l) => l.trimRight());
+    const links = await (async () => {
+      if (prFromSummary !== void 0) {
+        let { links: links2 } = await getInfoFromPullRequest({
+          repo: options.repo,
+          pull: prFromSummary
+        });
+        if (commitFromSummary) {
+          links2 = {
+            ...links2,
+            commit: `[\`${commitFromSummary}\`](https://github.com/${options.repo}/commit/${commitFromSummary})`
+          };
+        }
+        return links2;
+      }
+      const commitToFetchFrom = commitFromSummary || changeset.commit;
+      if (commitToFetchFrom) {
+        let { links: links2 } = await getInfo({
+          repo: options.repo,
+          commit: commitToFetchFrom
+        });
+        return links2;
+      }
+      return {
+        commit: null,
+        pull: null,
+        user: null
+      };
+    })();
+    const users = usersFromSummary.length ? usersFromSummary.map((userFromSummary) => `@${userFromSummary}`).join(", ") : links.user;
+    const prefix = links.pull ? `${links.pull} -` : links.commit ? `${links.commit} -` : "";
+    const suffix = users === null ? "" : `(${users})`;
+    return `
+
+- ${prefix} ${firstLine} ${suffix}
+${futureLines.map((l) => `  ${l}`).join("\n")}`;
+  }
+};
+var src_default = changelogFunctions;
+export {
+  src_default as default
+};

package/jest.config.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  clearMocks: true,
+  modulePathIgnorePatterns: ["<rootDir>/dist/"],
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@livekit/changesets-changelog-github",
+  "version": "0.0.1",
+  "description": "A compact changelog entry generator based on the official changesets changelog generator",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "license": "Apache 2.0",
+  "repository": "https://github.com/livekit/changesets-changelog-github",
+  "scripts": {
+    "build": "tsup-node",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@changesets/get-github-info": "^0.5.1",
+    "@changesets/types": "^5.2.0",
+    "dotenv": "^8.1.0"
+  },
+  "devDependencies": {
+    "@changesets/parse": "*",
+    "@types/jest": "29.1.1",
+    "jest": "^29.2.2",
+    "jest-junit": "^6.4.0",
+    "ts-jest": "29.0.3",
+    "tsup": "^6.3.0",
+    "typescript": "^4.8.4"
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,134 @@
+import changelogFunctions from "./index";
+import parse from "@changesets/parse";
+
+const getReleaseLine = changelogFunctions.getReleaseLine;
+
+jest.mock(
+  "@changesets/get-github-info",
+  (): typeof import("@changesets/get-github-info") => {
+    // this is duplicated because jest.mock reordering things
+    const data = {
+      commit: "a085003",
+      user: "Andarist",
+      pull: 1613,
+      repo: "emotion-js/emotion",
+    };
+    const links = {
+      user: `@${data.user}`,
+      pull: `[#${data.pull}](https://github.com/${data.repo}/pull/${data.pull})`,
+      commit: `[\`${data.commit}\`](https://github.com/${data.repo}/commit/${data.commit})`,
+    };
+    return {
+      async getInfo({ commit, repo }) {
+        expect(commit).toBe(data.commit);
+        expect(repo).toBe(data.repo);
+        return {
+          pull: data.pull,
+          user: data.user,
+          links,
+        };
+      },
+      async getInfoFromPullRequest({ pull, repo }) {
+        expect(pull).toBe(data.pull);
+        expect(repo).toBe(data.repo);
+        return {
+          commit: data.commit,
+          user: data.user,
+          links,
+        };
+      },
+    };
+  }
+);
+
+const getChangeset = (content: string, commit: string | undefined) => {
+  return [
+    {
+      ...parse(
+        `---
+  pkg: "minor"
+  ---
+  something
+  ${content}
+  `
+      ),
+      id: "some-id",
+      commit,
+    },
+    "minor",
+    { repo: data.repo },
+  ] as const;
+};
+
+const data = {
+  commit: "a085003",
+  user: "Andarist",
+  pull: 1613,
+  repo: "emotion-js/emotion",
+};
+
+describe.each([data.commit, "wrongcommit", undefined])(
+  "with commit from changeset of %s",
+  (commitFromChangeset) => {
+    describe.each(["pr", "pull request", "pull"])(
+      "override pr with %s keyword",
+      (keyword) => {
+        test.each(["with #", "without #"] as const)("%s", async (kind) => {
+          expect(
+            await getReleaseLine(
+              ...getChangeset(
+                `${keyword}: ${kind === "with #" ? "#" : ""}${data.pull}`,
+                commitFromChangeset
+              )
+            )
+          ).toEqual(
+            `\n\n- [#1613](https://github.com/emotion-js/emotion/pull/1613) - something (@Andarist)\n`
+          );
+        });
+      }
+    );
+    test("override commit with commit keyword", async () => {
+      expect(
+        await getReleaseLine(
+          ...getChangeset(`commit: ${data.commit}`, commitFromChangeset)
+        )
+      ).toEqual(
+        `\n\n- [#1613](https://github.com/emotion-js/emotion/pull/1613) - something (@Andarist)\n`
+      );
+    });
+  }
+);
+
+describe.each(["author", "user"])(
+  "override author with %s keyword",
+  (keyword) => {
+    test.each(["with @", "without @"] as const)("%s", async (kind) => {
+      expect(
+        await getReleaseLine(
+          ...getChangeset(
+            `${keyword}: ${kind === "with @" ? "@" : ""}other`,
+            data.commit
+          )
+        )
+      ).toEqual(
+        `\n\n- [#1613](https://github.com/emotion-js/emotion/pull/1613) - something (@other)\n`
+      );
+    });
+  }
+);
+
+it("with multiple authors", async () => {
+  expect(
+    await getReleaseLine(
+      ...getChangeset(
+        ["author: @Andarist", "author: @mitchellhamilton"].join("\n"),
+        data.commit
+      )
+    )
+  ).toMatchInlineSnapshot(`
+  "
+  
+  - [#1613](https://github.com/emotion-js/emotion/pull/1613) - something (@Andarist, @mitchellhamilton)
+  "
+  `);
+});

package/src/index.ts

@@ -0,0 +1,122 @@
+import { ChangelogFunctions } from "@changesets/types";
+// @ts-ignore
+import { config } from "dotenv";
+import { getInfo, getInfoFromPullRequest } from "@changesets/get-github-info";
+
+config();
+
+const changelogFunctions: ChangelogFunctions = {
+  getDependencyReleaseLine: async (
+    changesets,
+    dependenciesUpdated,
+    options
+  ) => {
+    if (!options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+      );
+    }
+    if (dependenciesUpdated.length === 0) return "";
+
+    const changesetLink = `- Updated dependencies [${(
+      await Promise.all(
+        changesets.map(async (cs) => {
+          if (cs.commit) {
+            let { links } = await getInfo({
+              repo: options.repo,
+              commit: cs.commit,
+            });
+            return links.commit;
+          }
+        })
+      )
+    )
+      .filter((_) => _)
+      .join(", ")}]:`;
+
+    const updatedDepenenciesList = dependenciesUpdated.map(
+      (dependency) => `  - ${dependency.name}@${dependency.newVersion}`
+    );
+
+    return [changesetLink, ...updatedDepenenciesList].join("\n");
+  },
+  getReleaseLine: async (changeset, type, options) => {
+    if (!options || !options.repo) {
+      throw new Error(
+        'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+      );
+    }
+
+    let prFromSummary: number | undefined;
+    let commitFromSummary: string | undefined;
+    let usersFromSummary: string[] = [];
+
+    const replacedChangelog = changeset.summary
+      .replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+        let num = Number(pr);
+        if (!isNaN(num)) prFromSummary = num;
+        return "";
+      })
+      .replace(/^\s*commit:\s*([^\s]+)/im, (_, commit) => {
+        commitFromSummary = commit;
+        return "";
+      })
+      .replace(/^\s*(?:author|user):\s*@?([^\s]+)/gim, (_, user) => {
+        usersFromSummary.push(user);
+        return "";
+      })
+      .trim();
+
+    const [firstLine, ...futureLines] = replacedChangelog
+      .split("\n")
+      .map((l) => l.trimRight());
+
+    const links = await (async () => {
+      if (prFromSummary !== undefined) {
+        let { links } = await getInfoFromPullRequest({
+          repo: options.repo,
+          pull: prFromSummary,
+        });
+        if (commitFromSummary) {
+          links = {
+            ...links,
+            commit: `[\`${commitFromSummary}\`](https://github.com/${options.repo}/commit/${commitFromSummary})`,
+          };
+        }
+        return links;
+      }
+      const commitToFetchFrom = commitFromSummary || changeset.commit;
+      if (commitToFetchFrom) {
+        let { links } = await getInfo({
+          repo: options.repo,
+          commit: commitToFetchFrom,
+        });
+        return links;
+      }
+      return {
+        commit: null,
+        pull: null,
+        user: null,
+      };
+    })();
+
+    const users = usersFromSummary.length
+      ? usersFromSummary
+          .map((userFromSummary) => `@${userFromSummary}`)
+          .join(", ")
+      : links.user;
+
+    const prefix = links.pull
+      ? `${links.pull} -`
+      : links.commit
+      ? `${links.commit} -`
+      : "";
+    const suffix = users === null ? "" : `(${users})`;
+
+    return `\n\n- ${prefix} ${firstLine} ${suffix}\n${futureLines
+      .map((l) => `  ${l}`)
+      .join("\n")}`;
+  },
+};
+
+export default changelogFunctions;

package/tsup.config.js

@@ -0,0 +1,10 @@
+/** @type {import("tsup").Options} */
+export const tsup = {
+  entryPoints: ["src/index.ts"],
+  format: ["esm", "cjs"],
+  sourcemap: false,
+  splitting: false,
+  clean: true,
+  shims: true,
+  target: "node14.13.1",
+};