@npmcli/template-oss 4.21.4 → 4.23.0

package/lib/release/node-workspace-format.js

@@ -3,7 +3,7 @@ const { ManifestPlugin } = require('release-please/build/src/plugin.js')
 const { addPath } = require('release-please/build/src/plugins/workspace.js')
 const { TagName } = require('release-please/build/src/util/tag-name.js')
 const { ROOT_PROJECT_PATH } = require('release-please/build/src/manifest.js')
-const { DEPS, link, wrapSpecs } = require('./util.js')
+const { DEPS, link, wrapSpecs, list } = require('./util.js')
 
 /* istanbul ignore next: TODO fix flaky tests and enable coverage */
 module.exports = class extends ManifestPlugin {
@@ -11,9 +11,8 @@ module.exports = class extends ManifestPlugin {
 
   #releasesByPackage = new Map()
   #pathsByComponent = new Map()
-  #WORKSPACE_SCOPE = /(?<scope>workspace): `?(?<name>\S+?)[@\s](?<version>\S+?)`?$/gm
 
-  async preconfigure (strategiesByPath) {
+  async preconfigure(strategiesByPath) {
     // First build a list of all releases that will happen based on
     // the conventional commits
     for (const path in strategiesByPath) {
@@ -26,32 +25,46 @@ module.exports = class extends ManifestPlugin {
     return strategiesByPath
   }
 
-  run (candidates) {
+  run(candidates) {
     this.#rewriteWorkspaceChangelogItems(candidates)
     this.#sortReleases(candidates)
     return candidates
   }
 
+  #replaceWorkspace({ name, versionRange }) {
+    const version = versionRange.replace(/^[\^~]/, '')
+    const { path, component } = this.#releasesByPackage.get(name)
+    const { tagSeparator, includeVInTag } = this.repositoryConfig[path]
+    const {
+      repository: { owner, repo },
+    } = this.github
+    const tag = new TagName(version, component, tagSeparator, includeVInTag).toString()
+    const url = `https://github.com/${owner}/${repo}/releases/tag/${tag}`
+    return list(`${link('workspace', url)}: ${wrapSpecs(`${name}@${version}`)}`)
+  }
+
   // I don't like how release-please formats workspace changelog entries
   // so this rewrites them to look like the rest of our changelog. This can't
   // be part of the changelog plugin since they are written after that by the
   // node-workspace plugin. A possible PR to release-please could add an option
   // to customize these or run them through the changelog notes generator.
-  #rewriteWorkspaceChangelogItems (candidates) {
+  #rewriteWorkspaceChangelogItems(candidates) {
     for (const candidate of candidates) {
       for (const release of candidate.pullRequest.body.releaseData) {
         // Update notes with a link to each workspaces release notes
         // now that we have all of the releases in a single pull request
-        release.notes =
-          release.notes.replace(this.#WORKSPACE_SCOPE, (...args) => {
-            const { scope, name, version } = args.pop()
-            const { path, component } = this.#releasesByPackage.get(name)
-            const { tagSeparator, includeVInTag } = this.repositoryConfig[path]
-            const { repository: { owner, repo } } = this.github
-            const tag = new TagName(version, component, tagSeparator, includeVInTag).toString()
-            const url = `https://github.com/${owner}/${repo}/releases/tag/${tag}`
-            return `${link(scope, url)}: ${wrapSpecs(`${name}@${version}`)}`
-          })
+        release.notes = release.notes
+          .replace(/^\* The following workspace dependencies were updated\n/gm, '')
+          .replace(/^\s{2}\* dependencies\n/gm, '')
+          .replace(/^\s{2}\* devDependencies\n/gm, '')
+          .replace(/^\s{2}\* peerDependencies\n/gm, '')
+          .replace(/^\s{2}\* optionalDependencies\n/gm, '')
+          .replace(/^\s{4}\* (?<name>[^\s]+) bumped to (?<versionRange>[^\s]+)/gm, (...args) =>
+            this.#replaceWorkspace(args.at(-1)),
+          )
+          .replace(/^\s{4}\* (?<name>[^\s]+) bumped from (?:[^\s]+) to (?<versionRange>[^\s]+)/gm, (...args) =>
+            this.#replaceWorkspace(args.at(-1)),
+          )
 
         // Find the associated changelog and update that too
         const path = this.#pathsByComponent.get(release.component)
@@ -66,7 +79,7 @@ module.exports = class extends ManifestPlugin {
 
   // Sort root release to the top of the pull request
   // release please pre sorts based on graph order so
-  #sortReleases (candidates) {
+  #sortReleases(candidates) {
     for (const candidate of candidates) {
       candidate.pullRequest.body.releaseData.sort((a, b) => {
         const aPath = this.#pathsByComponent.get(a.component)

package/lib/release/release-manager.js

@@ -21,17 +21,7 @@ class ReleaseManager {
 
   #info
 
-  constructor ({
-    token,
-    repo,
-    cwd = process.cwd(),
-    pr,
-    backport,
-    defaultTag,
-    lockfile,
-    publish,
-    silent,
-  }) {
+  constructor({ token, repo, cwd = process.cwd(), pr, backport, defaultTag, lockfile, publish, silent }) {
     assert(token, 'GITHUB_TOKEN is required')
     assert(repo, 'GITHUB_REPOSITORY is required')
     assert(cwd, 'cwd is required')
@@ -51,12 +41,12 @@ class ReleaseManager {
     this.#info = silent ? noop : core.info
   }
 
-  static async run (options) {
+  static async run(options) {
     const manager = new ReleaseManager(options)
     return manager.run()
   }
 
-  async run () {
+  async run() {
     const { data: pullRequest } = await this.#octokit.rest.pulls.get({
       owner: this.#owner,
       repo: this.#repo,
@@ -84,51 +74,55 @@ class ReleaseManager {
     return `### Release Checklist for ${release.tag}\n\n${checklist}`
   }
 
-  async #getPrReleases ({ pullRequest }) {
+  async #getPrReleases({ pullRequest }) {
     return /<details><summary>.*<\/summary>/.test(pullRequest.body)
       ? await this.#getPrMonoRepoReleases({ pullRequest })
       : [this.#getPrRootRelease({ pullRequest }), []]
   }
 
-  async #getPrMonoRepoReleases ({ pullRequest }) {
+  async #getPrMonoRepoReleases({ pullRequest }) {
     const releases = pullRequest.body.match(/<details><summary>.*<\/summary>/g)
     this.#info(`Found ${releases.length} releases`)
 
-    const workspacesComponents = [...await mapWorkspaces({
-      cwd: this.#cwd,
-      pkg: require(join(this.#cwd, 'package.json')),
-    })]
-      .reduce((acc, [k]) => {
-        const wsComponentName = k.startsWith('@') ? k.split('/')[1] : k
-        acc[wsComponentName] = k
-        return acc
-      }, {})
+    const workspacesComponents = [
+      ...(await mapWorkspaces({
+        cwd: this.#cwd,
+        pkg: require(join(this.#cwd, 'package.json')),
+      })),
+    ].reduce((acc, [k]) => {
+      const wsComponentName = k.startsWith('@') ? k.split('/')[1] : k
+      acc[wsComponentName] = k
+      return acc
+    }, {})
 
     const MONO_VERSIONS = /<details><summary>(?:(.*?):\s)?(.*?)<\/summary>/
 
-    return releases.reduce((acc, r) => {
-      const [, name, version] = r.match(MONO_VERSIONS)
+    return releases.reduce(
+      (acc, r) => {
+        const [, name, version] = r.match(MONO_VERSIONS)
 
-      const release = this.#getPrReleaseInfo({
-        pullRequest,
-        name,
-        version,
-        workspaces: workspacesComponents,
-      })
+        const release = this.#getPrReleaseInfo({
+          pullRequest,
+          name,
+          version,
+          workspaces: workspacesComponents,
+        })
 
-      if (release.isRoot) {
-        this.#info(`Found root: ${JSON.stringify(release)}`)
-        acc[0] = release
-      } else {
-        this.#info(`Found workspace: ${JSON.stringify(release)}`)
-        acc[1].push(release)
-      }
+        if (release.isRoot) {
+          this.#info(`Found root: ${JSON.stringify(release)}`)
+          acc[0] = release
+        } else {
+          this.#info(`Found workspace: ${JSON.stringify(release)}`)
+          acc[1].push(release)
+        }
 
-      return acc
-    }, [null, []])
+        return acc
+      },
+      [null, []],
+    )
   }
 
-  #getPrRootRelease ({ pullRequest }) {
+  #getPrRootRelease({ pullRequest }) {
     this.#info('Found no monorepo, checking for single root version')
 
     const match = pullRequest.body.match(/\n##\s\[(.*?)\]/)
@@ -140,7 +134,7 @@ class ReleaseManager {
     return this.#getPrReleaseInfo({ pullRequest, version })
   }
 
-  #getPrReleaseInfo ({ pullRequest, workspaces = {}, name = null, version: rawVersion }) {
+  #getPrReleaseInfo({ pullRequest, workspaces = {}, name = null, version: rawVersion }) {
     const version = semver.parse(rawVersion)
     const prerelease = !!version.prerelease.length
     const tag = `${name ? `${name}-` : ''}v${rawVersion}`
@@ -156,51 +150,47 @@ class ReleaseManager {
       version: rawVersion,
       major: version.major,
       url: `https://github.com/${pullRequest.base.repo.full_name}/releases/tag/${tag}`,
-      flags: [
-        workspaces[name] ? `-w ${workspaces[name]}` : null,
-        `--tag=${publishTag}`,
-      ].filter(Boolean).join(' '),
+      flags: [workspaces[name] ? `-w ${workspaces[name]}` : null, `--tag=${publishTag}`].filter(Boolean).join(' '),
     }
   }
 
-  async #getReleaseProcess ({ release, workspaces }) {
+  async #getReleaseProcess({ release, workspaces }) {
     const RELEASE_LIST_ITEM = /^\d+\.\s/gm
 
     this.#info(`Fetching release process from repo wiki: ${this.#owner}/${this.#repo}`)
 
     const releaseProcess = await fetch(
-      `https://raw.githubusercontent.com/wiki/${this.#owner}/${this.#repo}/Release-Process.md`
-    )
-      .then(r => {
-        // If the url fails with anything but a 404 we want the process to blow
-        // up because that means something is very wrong. This is a rare edge
-        // case that isn't worth testing.
-        /* istanbul ignore else */
-        if (r.statusCode === 200) {
-          this.#info('Found release process from wiki')
-          return r.body.text()
-        } else if (r.statusCode === 404) {
-          this.#info('No release process found in wiki, falling back to default process')
-          return this.#getReleaseSteps()
-        } else {
-          throw new Error(`Release process fetch failed with status: ${r.statusCode}`)
-        }
-      })
+      `https://raw.githubusercontent.com/wiki/${this.#owner}/${this.#repo}/Release-Process.md`,
+    ).then(r => {
+      // If the url fails with anything but a 404 we want the process to blow
+      // up because that means something is very wrong. This is a rare edge
+      // case that isn't worth testing.
+      /* istanbul ignore else */
+      if (r.statusCode === 200) {
+        this.#info('Found release process from wiki')
+        return r.body.text()
+      } else if (r.statusCode === 404) {
+        this.#info('No release process found in wiki, falling back to default process')
+        return this.#getReleaseSteps()
+      } else {
+        throw new Error(`Release process fetch failed with status: ${r.statusCode}`)
+      }
+    })
 
     // XXX: the release steps need to always be the last thing in the doc for this to work
     const releaseLines = releaseProcess.split('\n')
-    const releaseStartLine = releaseLines.reduce((acc, l, i) => l.match(/^#+\s/) ? i : acc, 0)
+    const releaseStartLine = releaseLines.reduce((acc, l, i) => (l.match(/^#+\s/) ? i : acc), 0)
     const section = releaseLines.slice(releaseStartLine).join('\n')
 
     return section
       .split({
-        [Symbol.split]: (str) => {
+        [Symbol.split]: str => {
           const [, ...matches] = str.split(RELEASE_LIST_ITEM)
           this.#info(`Found ${matches.length} release items`)
-          return matches.map((m) => `- [ ] <STEP_INDEX>. ${m}`.trim())
+          return matches.map(m => `- [ ] <STEP_INDEX>. ${m}`.trim())
         },
       })
-      .filter((item) => {
+      .filter(item => {
         if (release.prerelease && item.includes('> NOT FOR PRERELEASE')) {
           return false
         }
@@ -214,7 +204,7 @@ class ReleaseManager {
       .map((item, index) => item.replace('<STEP_INDEX>', index + 1))
   }
 
-  #getReleaseSteps () {
+  #getReleaseSteps() {
     const R = `-R ${this.#owner}/${this.#repo}`
 
     const manualSteps = `
@@ -275,12 +265,7 @@ class ReleaseManager {
     `
     /* eslint-enable max-len */
 
-    return [
-      this.#publish ? autoSteps : manualSteps,
-      alwaysSteps,
-    ]
-      .map(v => dedent(v))
-      .join('\n\n')
+    return [this.#publish ? autoSteps : manualSteps, alwaysSteps].map(v => dedent(v)).join('\n\n')
   }
 }
 

package/lib/release/release-please.js

@@ -1,17 +1,12 @@
 const RP = require('release-please')
-const {
-  DefaultVersioningStrategy,
-} = require('release-please/build/src/versioning-strategies/default.js')
-const {
-  PrereleaseVersioningStrategy,
-} = require('release-please/build/src/versioning-strategies/prerelease.js')
+const { DefaultVersioningStrategy } = require('release-please/build/src/versioning-strategies/default.js')
+const { PrereleaseVersioningStrategy } = require('release-please/build/src/versioning-strategies/prerelease.js')
 const { ROOT_PROJECT_PATH } = require('release-please/build/src/manifest.js')
 const { CheckpointLogger, logger } = require('release-please/build/src/util/logger.js')
 const assert = require('assert')
 const core = require('@actions/core')
 const omit = require('just-omit')
 const ChangelogNotes = require('./changelog.js')
-const NodeWorkspace = require('./node-workspace.js')
 const NodeWorkspaceFormat = require('./node-workspace-format.js')
 const { getPublishTag, noop } = require('./util.js')
 
@@ -32,16 +27,7 @@ class ReleasePlease {
   #octokit
   #manifest
 
-  constructor ({
-    token,
-    repo,
-    branch,
-    backport,
-    defaultTag,
-    overrides,
-    silent,
-    trace,
-  }) {
+  constructor({ token, repo, branch, backport, defaultTag, overrides, silent, trace }) {
     assert(token, 'token is required')
     assert(repo, 'repo is required')
     assert(branch, 'branch is required')
@@ -58,30 +44,33 @@ class ReleasePlease {
     this.#trace = trace
   }
 
-  static async run (options) {
+  static async run(options) {
     const releasePlease = new ReleasePlease(options)
     await releasePlease.init()
     return releasePlease.run()
   }
 
-  async init () {
-    RP.registerChangelogNotes('default', ({ github, ...o }) =>
-      new ChangelogNotes(github, o))
-    RP.registerVersioningStrategy('default', (o) =>
-      o.prerelease ? new PrereleaseVersioningStrategy(o) : new DefaultVersioningStrategy(o))
-    RP.registerPlugin('node-workspace', ({ github, targetBranch, repositoryConfig, ...o }) =>
-      new NodeWorkspace(github, targetBranch, repositoryConfig, o))
-    RP.registerPlugin('node-workspace-format', ({ github, targetBranch, repositoryConfig, ...o }) =>
-      new NodeWorkspaceFormat(github, targetBranch, repositoryConfig, o))
+  async init() {
+    RP.registerChangelogNotes('default', ({ github, ...o }) => new ChangelogNotes(github, o))
+    RP.registerVersioningStrategy('default', o =>
+      o.prerelease ? new PrereleaseVersioningStrategy(o) : new DefaultVersioningStrategy(o),
+    )
+    RP.registerPlugin(
+      'node-workspace-format',
+      ({ github, targetBranch, repositoryConfig, ...o }) =>
+        new NodeWorkspaceFormat(github, targetBranch, repositoryConfig, o),
+    )
 
     if (this.#silent) {
       this.#info = noop
-      RP.setLogger(Object.entries(logger).reduce((acc, [k, v]) => {
-        if (typeof v === 'function') {
-          acc[k] = noop
-        }
-        return acc
-      }, {}))
+      RP.setLogger(
+        Object.entries(logger).reduce((acc, [k, v]) => {
+          if (typeof v === 'function') {
+            acc[k] = noop
+          }
+          return acc
+        }, {}),
+      )
     } else {
       this.#info = core.info
       RP.setLogger(new CheckpointLogger(true, !!this.#trace))
@@ -93,16 +82,10 @@ class ReleasePlease {
       token: this.#token,
     })
     this.#octokit = this.#github.octokit
-    this.#manifest = await RP.Manifest.fromManifest(
-      this.#github,
-      this.#branch,
-      undefined,
-      undefined,
-      this.#overrides
-    )
+    this.#manifest = await RP.Manifest.fromManifest(this.#github, this.#branch, undefined, undefined, this.#overrides)
   }
 
-  async run () {
+  async run() {
     const rootPr = await this.#getRootPullRequest()
     const releases = await this.#getReleases()
 
@@ -111,11 +94,13 @@ class ReleasePlease {
 
       // release please does not guarantee that the release PR will have the latest sha,
       // but we always need it so we can attach the relevant checks to the sha.
-      rootPr.sha = await this.#octokit.paginate(this.#octokit.rest.pulls.listCommits, {
-        owner: this.#owner,
-        repo: this.#repo,
-        pull_number: rootPr.number,
-      }).then(r => r[r.length - 1].sha)
+      rootPr.sha = await this.#octokit
+        .paginate(this.#octokit.rest.pulls.listCommits, {
+          owner: this.#owner,
+          repo: this.#repo,
+          pull_number: rootPr.number,
+        })
+        .then(r => r[r.length - 1].sha)
     }
 
     if (releases) {
@@ -129,19 +114,23 @@ class ReleasePlease {
           defaultTag: this.#defaultTag,
         })
 
-        release.prNumber = await this.#octokit.rest.repos.listPullRequestsAssociatedWithCommit({
-          owner: this.#owner,
-          repo: this.#repo,
-          commit_sha: release.sha,
-          per_page: 1,
-        }).then(r => r.data[0]?.number)
-
-        release.pkgName = await this.#octokit.rest.repos.getContent({
-          owner: this.#owner,
-          repo: this.#repo,
-          ref: this.#branch,
-          path: `${release.path === '.' ? '' : release.path}/package.json`,
-        }).then(r => JSON.parse(Buffer.from(r.data.content, r.data.encoding)).name)
+        release.prNumber = await this.#octokit.rest.repos
+          .listPullRequestsAssociatedWithCommit({
+            owner: this.#owner,
+            repo: this.#repo,
+            commit_sha: release.sha,
+            per_page: 1,
+          })
+          .then(r => r.data[0]?.number)
+
+        release.pkgName = await this.#octokit.rest.repos
+          .getContent({
+            owner: this.#owner,
+            repo: this.#repo,
+            ref: this.#branch,
+            path: `${release.path === '.' ? '' : release.path}/package.json`,
+          })
+          .then(r => JSON.parse(Buffer.from(r.data.content, r.data.encoding)).name)
       }
     }
 
@@ -151,14 +140,14 @@ class ReleasePlease {
     }
   }
 
-  async #getRootPullRequest () {
+  async #getRootPullRequest() {
     // We only ever get a single pull request with our current release-please settings
     // Update this if we start creating individual PRs per workspace release
     const pullRequests = await this.#manifest.createPullRequests()
     return pullRequests.filter(Boolean)[0] ?? null
   }
 
-  async #getReleases () {
+  async #getReleases() {
     // if we have a root release, always put it as the first item in the array
     const rawReleases = await this.#manifest.createReleases().then(r => r.filter(Boolean))
     let rootRelease = null

package/lib/release/util.js

@@ -1,11 +1,11 @@
 const semver = require('semver')
 
 const SPEC = new RegExp(`([^\\s]+@${semver.src[semver.tokens.FULLPLAIN]})`, 'g')
-const code = (c) => `\`${c}\``
-const wrapSpecs = (str) => str.replace(SPEC, code('$1'))
-const block = (lang) => `\`\`\`${lang ? `${lang}` : ''}`
+const code = c => `\`${c}\``
+const wrapSpecs = str => str.replace(SPEC, code('$1'))
+const block = lang => `\`\`\`${lang ? `${lang}` : ''}`
 const link = (text, url) => `[${text}](${url})`
-const list = (text) => `* ${text}`
+const list = text => `* ${text}`
 const formatDate = (date = new Date()) => {
   const year = date.getFullYear()
   const month = (date.getMonth() + 1).toString().padStart(2, '0')
@@ -17,12 +17,15 @@ const getPublishTag = (v, { backport, defaultTag }) => {
   const version = semver.parse(v)
   return version.prerelease.length
     ? `prerelease-${version.major}`
-    : backport ? `latest-${backport}`
-    : defaultTag.replace(/{{\s*major\s*}}/, version.major)
+    : backport
+      ? `latest-${backport}`
+      : defaultTag.replace(/{{\s*major\s*}}/, version.major)
 }
 
-const makeGitHubUrl = (owner, repo) =>
-  (...p) => `https://github.com/${owner}/${repo}/${p.join('/')}`
+const makeGitHubUrl =
+  (owner, repo) =>
+  (...p) =>
+    `https://github.com/${owner}/${repo}/${p.join('/')}`
 
 const noop = () => {}
 

package/lib/util/ci-versions.js

@@ -1,16 +1,16 @@
 const { uniq, range, isPlainObject } = require('lodash')
 const semver = require('semver')
 
-const parseCiVersions = (ciVersions) => {
+const parseCiVersions = ciVersions => {
   if (Array.isArray(ciVersions)) {
-    return Object.fromEntries(ciVersions.map((v) => [v, true]))
+    return Object.fromEntries(ciVersions.map(v => [v, true]))
   }
   if (isPlainObject(ciVersions)) {
     return ciVersions
   }
 }
 
-const getLowerBounds = (sRange) => {
+const getLowerBounds = sRange => {
   return new semver.Range(sRange).set.map(c => c[0])
 }
 

package/lib/util/dependabot.js

@@ -1,7 +1,7 @@
 const { name: NAME } = require('../../package.json')
 const { minimatch } = require('minimatch')
 
-const parseDependabotConfig = (v) => typeof v === 'string' ? { strategy: v } : (v ?? {})
+const parseDependabotConfig = v => (typeof v === 'string' ? { strategy: v } : v ?? {})
 
 module.exports = (config, defaultConfig, branches) => {
   const { dependabot } = config
@@ -12,7 +12,7 @@ module.exports = (config, defaultConfig, branches) => {
   }
 
   return branches
-    .filter((b) => dependabot[b] !== false)
+    .filter(b => dependabot[b] !== false)
     .map(branch => {
       const isReleaseBranch = minimatch(branch, config.releaseBranch)
       return {