@hadl-labs/changelog-github 0.1.0 → 0.3.0

package/prettier.config.js

@@ -1,8 +0,0 @@
-/** @type {import("prettier").Options} */
-const config = {
-  semi: false,
-  experimentalTernaries: true,
-  printWidth: 100,
-}
-
-export default config

package/src/index.test.ts

@@ -1,109 +0,0 @@
-import changelogFunctions from "./index"
-import parse from "@changesets/parse"
-import type { getInfo, getInfoFromPullRequest } from "@changesets/get-github-info"
-
-type GetInfoRequest = Parameters<typeof getInfo>[0]
-type GetInfoFromPullRequestRequest = Parameters<typeof getInfoFromPullRequest>[0]
-
-const getReleaseLine = changelogFunctions.getReleaseLine
-
-const mockData = {
-  commit: "a085003",
-  user: "Andarist",
-  pull: 1613,
-  repo: "emotion-js/emotion",
-}
-
-const mockLinks = {
-  user: `[@${mockData.user}](https://github.com/${mockData.user})`,
-  pull: `[#${mockData.pull}](https://github.com/${mockData.repo}/pull/${mockData.pull})`,
-  commit: `[\`${mockData.commit}\`](https://github.com/${mockData.repo}/commit/${mockData.commit})`,
-}
-
-jest.mock("@changesets/get-github-info", () => ({
-  getInfo: ({ commit, repo }: GetInfoRequest) => {
-    expect(commit).toBe(mockData.commit)
-    expect(repo).toBe(mockData.repo)
-    return Promise.resolve({
-      pull: mockData.pull,
-      user: mockData.user,
-      links: mockLinks,
-    })
-  },
-  getInfoFromPullRequest: ({ pull, repo }: GetInfoFromPullRequestRequest) => {
-    expect(pull).toBe(mockData.pull)
-    expect(repo).toBe(mockData.repo)
-    return Promise.resolve({
-      commit: mockData.commit,
-      user: mockData.user,
-      links: mockLinks,
-    })
-  },
-}))
-
-const getChangeset = (content: string, commit: string | undefined) => {
-  return [
-    {
-      ...parse(
-        `---
-pkg: "minor"
----
-something
-${content}
-`,
-      ),
-      id: "some-id",
-      commit,
-    },
-    "minor",
-    { repo: mockData.repo },
-  ] as const
-}
-
-describe.each([mockData.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) => {
-        const result = await getReleaseLine(
-          ...getChangeset(
-            `${keyword}: ${kind === "with #" ? "#" : ""}${mockData.pull}`,
-            commitFromChangeset,
-          ),
-        )
-        expect(result).toEqual(
-          `\n\n- [#1613](https://github.com/emotion-js/emotion/pull/1613) [\`a085003\`](https://github.com/emotion-js/emotion/commit/a085003) Thanks [@Andarist](https://github.com/Andarist)! - something\n`,
-        )
-      })
-    })
-
-    test("override commit with commit keyword", async () => {
-      const result = await getReleaseLine(
-        ...getChangeset(`commit: ${mockData.commit}`, commitFromChangeset),
-      )
-      expect(result).toEqual(
-        `\n\n- [#1613](https://github.com/emotion-js/emotion/pull/1613) [\`a085003\`](https://github.com/emotion-js/emotion/commit/a085003) Thanks [@Andarist](https://github.com/Andarist)! - something\n`,
-      )
-    })
-  },
-)
-
-describe.each(["author", "user"])("override author with %s keyword", (keyword) => {
-  test.each(["with @", "without @"] as const)(" %s", async (kind) => {
-    const result = await getReleaseLine(
-      ...getChangeset(`${keyword}: ${kind === "with @" ? "@" : ""}other`, mockData.commit),
-    )
-    expect(result).toEqual(
-      `\n\n- [#1613](https://github.com/emotion-js/emotion/pull/1613) [\`a085003\`](https://github.com/emotion-js/emotion/commit/a085003) Thanks [@other](https://github.com/other)! - something\n`,
-    )
-  })
-})
-
-it("with multiple authors", async () => {
-  const result = await getReleaseLine(
-    ...getChangeset(["author: @Andarist", "author: @mitchellhamilton"].join("\n"), mockData.commit),
-  )
-  expect(result).toBe(
-    "\n\n- [#1613](https://github.com/emotion-js/emotion/pull/1613) [\`a085003\`](https://github.com/emotion-js/emotion/commit/a085003) Thanks [@Andarist](https://github.com/Andarist), [@mitchellhamilton](https://github.com/mitchellhamilton)! - something\n",
-  )
-})

package/src/index.ts

@@ -1,113 +0,0 @@
-import type { ChangelogFunctions } from "@changesets/types"
-import { getInfo, getInfoFromPullRequest } from "@changesets/get-github-info"
-
-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) {
-          const shortCommitId = commitFromSummary.slice(0, 7)
-          links = {
-            ...links,
-            commit: `[\`${shortCommitId}\`](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}](https://github.com/${userFromSummary})`)
-          .join(", ")
-      : links.user
-
-    const prefix = [
-      links.pull === null ? "" : ` ${links.pull}`,
-      links.commit === null ? "" : ` ${links.commit}`,
-      users === null ? "" : ` Thanks ${users}!`,
-    ].join("")
-
-    return `\n\n-${prefix ? `${prefix} -` : ""} ${firstLine}\n${futureLines
-      .map((l) => `  ${l}`)
-      .join("\n")}`
-  },
-}
-
-export default changelogFunctions

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}