@npmcli/template-oss 4.21.4 → 4.23.0

package/lib/content/_job-matrix-yml.hbs

@@ -11,6 +11,9 @@ strategy:
       - name: macOS
         os: macos-latest
         shell: bash
+      - name: macOS
+        os: macos-13
+        shell: bash
       {{/if}}
       {{#if windowsCI}}
       - name: Windows
@@ -21,6 +24,13 @@ strategy:
       {{#each ciVersions}}
       - {{ . }}
       {{/each}}
+    {{#if macCI}}
+    exclude:
+      {{#each ciVersions}}
+      - platform: {name: macOS, os: macos-{{#if (lte (semverRangeMajor .) 14)}}latest{{else}}13{{/if}}, shell: bash}
+        node-version: {{ . }}
+      {{/each}}
+    {{/if}}
 runs-on: $\{{ matrix.platform.os }}
 defaults:
   run:

package/lib/content/_job-release-integration-yml.hbs

@@ -19,26 +19,21 @@ steps:
   {{else}}
   {{> stepsSetupYml }}
   - name: Check If Published
+    env:
+      RELEASES: $\{{ inputs.releases }}
   {{/if}}
     run: |
       EXIT_CODE=0
 
-      function each_release {
-        if {{#if publish}}npm publish --provenance --tag="$1"{{else}}npm view "$@" --loglevel=error > /dev/null{{/if}}; then
-          echo 0
-        else
-          echo 1
-        fi
-      }
-
       for release in $(echo $RELEASES | jq -r '.[] | @base64'); do
         {{#if publish}}
         PUBLISH_TAG=$(echo "$release" | base64 --decode | jq -r .publishTag)
-        STATUS=$(each_release "$PUBLISH_TAG")
+        npm publish --provenance --tag="$PUBLISH_TAG"
         {{else}}
         SPEC="$(echo "$release" | base64 --decode | jq -r .pkgName)@$(echo "$release" | base64 --decode | jq -r .version)"
-        STATUS=$(each_release "$SPEC")
+        npm view "$SPEC" --json
         {{/if}}
+        STATUS=$?
         if [[ "$STATUS" -eq 1 ]]; then
           EXIT_CODE=$STATUS
         {{#unless publish}}

package/lib/content/_step-git-yml.hbs

@@ -1,5 +1,5 @@
 - name: Checkout
-  uses: actions/checkout@v3
+  uses: actions/checkout@v4
   {{#if jobCheckout}}
   with:
   {{#each jobCheckout}}

package/lib/content/_step-node-yml.hbs

@@ -1,5 +1,5 @@
 - name: Setup Node
-  uses: actions/setup-node@v3
+  uses: actions/setup-node@v4
   id: node
   with:
     node-version: {{#if jobIsMatrix}}$\{{ matrix.node-version }}{{else}}{{ last ciVersions }}{{/if}}

package/lib/content/action-create-check-yml.hbs

@@ -15,7 +15,7 @@ runs:
   using: "composite"
   steps:
     - name: Get Workflow Job
-      uses: actions/github-script@v6
+      uses: actions/github-script@v7
       id: workflow
       env:
         JOB_NAME: "$\{{ inputs.name }}"

package/lib/content/ci-release-yml.hbs

@@ -27,7 +27,7 @@ jobs:
       {{> stepLintYml jobRunFlags=allFlags }}
       - name: Conclude Check
         uses: LouisBrunner/checks-action@v1.6.0
-        if: always()
+        if: steps.create-check.outputs.check-id && always()
         with:
           token: $\{{ secrets.GITHUB_TOKEN }}
           conclusion: $\{{ job.status }}
@@ -42,7 +42,7 @@ jobs:
       {{> stepTestYml jobRunFlags=allFlags }}
       - name: Conclude Check
         uses: LouisBrunner/checks-action@v1.6.0
-        if: always()
+        if: steps.create-check.outputs.check-id && always()
         with:
           token: $\{{ secrets.GITHUB_TOKEN }}
           conclusion: $\{{ job.status }}

package/lib/content/eslintrc-js.hbs

@@ -9,13 +9,9 @@ const localConfigs = readdir(__dirname)
 module.exports = {
   root: true,
   ignorePatterns: [
-    'tap-testdir*/',
-    {{#each workspaceGlobs}}
+    {{#each lintIgnorePaths}}
     '{{ . }}',
     {{/each}}
-    {{#if typescript}}
-    'dist/',
-    {{/if}}
   ],
   {{#if typescript}}
   parser: '@typescript-eslint/parser',
@@ -28,5 +24,8 @@ module.exports = {
   extends: [
     '@npmcli',
     ...localConfigs,
+    {{#if prettier}}
+    'prettier',
+    {{/if}}
   ],
 }

package/lib/content/gitignore.hbs

@@ -1,9 +1,6 @@
 # ignore everything in the root
 /*
-# transient test directories
-tap-testdir*/
 
-# keep these
 {{#each ignorePaths}}
 {{ . }}
 {{/each}}

package/lib/content/index.js

@@ -1,8 +1,8 @@
 const { name: NAME, version: LATEST_VERSION } = require('../../package.json')
 
-const isPublic = (p) => p.config.isPublic
+const isPublic = p => p.config.isPublic
 
-const sharedRootAdd = (name) => ({
+const sharedRootAdd = name => ({
   // release
   '.github/workflows/release.yml': {
     file: 'release-yml.hbs',
@@ -19,17 +19,17 @@ const sharedRootAdd = (name) => ({
   '.release-please-manifest.json': {
     file: 'release-please-manifest-json.hbs',
     filter: isPublic,
-    parser: (p) => p.JsonMergeNoComment,
+    parser: p => p.JsonMergeNoComment,
   },
   'release-please-config.json': {
     file: 'release-please-config-json.hbs',
     filter: isPublic,
-    parser: (p) => p.JsonMergeNoComment,
+    parser: p => p.JsonMergeNoComment,
   },
   'tsconfig.json': {
     file: 'tsconfig-json.hbs',
-    filter: (p) => p.config.typescript,
-    parser: (p) => p.JsonMergeNoComment,
+    filter: p => p.config.typescript,
+    parser: p => p.JsonMergeNoComment,
   },
   // this lint commits which is only necessary for releases
   '.github/workflows/pull-request.yml': {
@@ -42,15 +42,15 @@ const sharedRootAdd = (name) => ({
   // dependabot
   '.github/dependabot.yml': {
     file: 'dependabot-yml.hbs',
-    filter: (p) => p.config.dependabot,
+    filter: p => p.config.dependabot,
   },
   '.github/workflows/post-dependabot.yml': {
     file: 'post-dependabot-yml.hbs',
-    filter: (p) => p.config.dependabot,
+    filter: p => p.config.dependabot,
   },
   '.github/settings.yml': {
     file: 'settings-yml.hbs',
-    filter: (p) => !p.config.isReleaseBranch,
+    filter: p => !p.config.isReleaseBranch,
   },
   // composite actions
   '.github/actions/install-latest-npm/action.yml': 'action-install-latest-npm-yml.hbs',
@@ -59,10 +59,10 @@ const sharedRootAdd = (name) => ({
 
 const sharedRootRm = () => ({
   '.github/workflows/pull-request.yml': {
-    filter: (p) => p.config.allPrivate,
+    filter: p => p.config.allPrivate,
   },
   '.github/settings.yml': {
-    filter: (p) => p.config.isReleaseBranch,
+    filter: p => p.config.isReleaseBranch,
   },
 })
 
@@ -94,7 +94,15 @@ const rootModule = {
   add: {
     '.eslintrc.{{ cjsExt }}': {
       file: 'eslintrc-js.hbs',
-      filter: (p) => p.config.eslint,
+      filter: p => p.config.eslint,
+    },
+    '.prettierrc.{{ cjsExt }}': {
+      file: 'prettier-js.hbs',
+      filter: p => p.config.prettier,
+    },
+    '.prettierignore': {
+      file: 'prettierignore.hbs',
+      filter: p => p.config.prettier,
     },
     '.gitignore': 'gitignore.hbs',
     '.npmrc': 'npmrc.hbs',
@@ -103,9 +111,7 @@ const rootModule = {
     'CONTRIBUTING.md': 'CONTRIBUTING-md.hbs',
     'package.json': 'package-json.hbs',
   },
-  rm: [
-    '.eslintrc.!({{ cjsExt }}|local.*)',
-  ],
+  rm: ['.eslintrc.!({{ cjsExt }}|local.*)'],
 }
 
 // Changes for each workspace but applied to the root of the repo
@@ -125,16 +131,12 @@ const workspaceModule = {
   add: {
     '.eslintrc.{{ cjsExt }}': {
       file: 'eslintrc-js.hbs',
-      filter: (p) => p.config.eslint,
+      filter: p => p.config.eslint,
     },
     '.gitignore': 'gitignore.hbs',
     'package.json': 'package-json.hbs',
   },
-  rm: [
-    '.npmrc',
-    '.eslintrc.!({{ cjsExt }}|local.*)',
-    'SECURITY.md',
-  ],
+  rm: ['.npmrc', '.eslintrc.!({{ cjsExt }}|local.*)', 'SECURITY.md'],
 }
 
 module.exports = {
@@ -151,10 +153,7 @@ module.exports = {
   // {{major}} to have the major version being published replaced in the string.
   defaultPublishTag: 'latest',
   releaseBranch: 'release/v*',
-  distPaths: [
-    'bin/',
-    'lib/',
-  ],
+  distPaths: ['bin/', 'lib/'],
   allowDistPaths: true,
   allowPaths: [
     '/.eslintrc.local.*',
@@ -167,15 +166,21 @@ module.exports = {
     '/README*',
     '/LICENSE*',
     '/CHANGELOG*',
+    '/.git-blame-ignore-revs',
   ],
-  ignorePaths: [
-    /* to be provided by consuming package */
+  ignorePaths: ['tap-testdir*/'],
+  lintIgnorePaths: [
+    // can be set by consumer
   ],
+  lintExtensions: ['js', 'cjs', 'ts', 'mjs', 'jsx', 'tsx'],
+  formatIgnorePaths: ['tap-snapshots/', 'test/fixtures/**/*.json'],
+  formatExtensions: ['js', 'cjs', 'ts', 'mjs', 'jsx', 'tsx', 'json'],
   ciVersions: {},
-  latestCiVersion: 20,
+  latestCiVersion: 22,
   lockfile: false,
   codeowner: '@npm/cli-team',
   eslint: true,
+  prettier: false,
   publish: false,
   typescript: false,
   esm: false,
@@ -191,18 +196,14 @@ module.exports = {
     'standard',
   ],
   requiredPackages: {
-    devDependencies: [
-      `${NAME}@${LATEST_VERSION}`,
-      '@npmcli/eslint-config',
-      'tap',
-    ],
+    devDependencies: [`${NAME}@${LATEST_VERSION}`, '@npmcli/eslint-config', 'tap'],
   },
   allowedPackages: [],
   changelogTypes: [
-    { type: 'feat', section: 'Features', hidden: false, collapse: false },
-    { type: 'fix', section: 'Bug Fixes', hidden: false, collapse: false },
-    { type: 'docs', section: 'Documentation', hidden: false, collapse: false },
-    { type: 'deps', section: 'Dependencies', hidden: false, collapse: false },
-    { type: 'chore', section: 'Chores', hidden: false, collapse: false },
+    { type: 'feat', section: 'Features', hidden: false },
+    { type: 'fix', section: 'Bug Fixes', hidden: false },
+    { type: 'docs', section: 'Documentation', hidden: false },
+    { type: 'deps', section: 'Dependencies', hidden: false },
+    { type: 'chore', section: 'Chores', hidden: true },
   ],
 }

package/lib/content/package-json.hbs

@@ -3,10 +3,20 @@
   "files": {{{ json distPaths }}},
   "type": {{#if esm}}"module"{{else}}{{{ del }}}{{/if}},
   "scripts": {
-    "lint": "{{#if eslint}}eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"{{else}}echo linting disabled{{/if}}",
+    {{#if eslint}}
+    "eslint": "eslint \"**/*.{{{ extGlob lintExtensions }}}\"",
+    "lint": "{{ localNpmPath }} run eslint {{~#if prettier}} && {{ localNpmPath }} run prettier -- --check{{/if}}",
+    "lintfix": "{{ localNpmPath }} run eslint -- --fix {{~#if prettier}} && {{ localNpmPath }} run prettier -- --write{{/if}}",
+    {{#if prettier}}
+    "prettier": "prettier \"**/*.{{{ extGlob formatExtensions }}}\"",
+    {{/if}}
+    {{else}}
+    "eslint": {{{ del }}},
+    "lint": "echo linting disabled",
+    "lintfix": {{{ del }}},
+    {{/if}}
     "postlint": "template-oss-check",
     "template-oss-apply": "template-oss-apply --force",
-    "lintfix": "{{ localNpmPath }} run lint -- --fix",
     "snap": "{{#if typescript}}{{#if tap16}}c8 {{/if}}{{/if}}tap",
     "test": "{{#if typescript}}{{#if tap16}}c8 {{/if}}{{/if}}tap",
     "posttest": "{{ localNpmPath }} run lint",

package/lib/content/prettier-js.hbs

@@ -0,0 +1,6 @@
+const githubConfig = require('@github/prettier-config')
+
+module.exports = {
+  ...githubConfig,
+  bracketSpacing: true,
+}

package/lib/content/prettierignore.hbs

@@ -0,0 +1,3 @@
+{{#each formatIgnorePaths}}
+{{ . }}
+{{/each}}

package/lib/content/release-yml.hbs

@@ -30,7 +30,7 @@ jobs:
         run: {{ rootNpxPath }} --offline template-oss-release-please --branch="$\{{ github.ref_name }}" --backport="{{ backport }}" --defaultTag="{{ defaultPublishTag }}"
       - name: Create Release Manager Comment Text
         if: steps.release.outputs.pr-number
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         id: comment-text
         with:
           result-encoding: string
@@ -156,7 +156,7 @@ jobs:
     {{> jobYml jobName="Post Release - Release" jobIf="needs.release.outputs.releases" jobSkipSetup=true  }}
       - name: Create Release PR Comment Text
         id: comment-text
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         env:
           RELEASES: $\{{ needs.release.outputs.releases }}
         with:
@@ -217,7 +217,7 @@ jobs:
       - name: Create Release PR Comment Text
         id: comment-text
         if: steps.found-comment.outputs.comment-id
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         env:
           RESULT: $\{{ steps.conclusion.outputs.result }}
           BODY: $\{{ steps.found-comment.outputs.comment-body }}

package/lib/index.js

@@ -4,7 +4,7 @@ const getConfig = require('./config.js')
 const PackageJson = require('@npmcli/package-json')
 const mapWorkspaces = require('@npmcli/map-workspaces')
 
-const getPkg = async (path) => {
+const getPkg = async path => {
   log.verbose('get-pkg', path)
 
   const pkgJson = (await PackageJson.load(path)).content
@@ -27,7 +27,7 @@ const getWsPkgs = async (root, rootPkg) => {
 
   // Include all by default
   const { workspaces } = rootPkg.config
-  const include = (name) => Array.isArray(workspaces) ? workspaces.includes(name) : true
+  const include = name => (Array.isArray(workspaces) ? workspaces.includes(name) : true)
 
   // Look through all workspaces on the root pkg
   const rootWorkspaces = await mapWorkspaces({ pkg: rootPkg.pkgJson, cwd: root })
@@ -43,7 +43,7 @@ const getWsPkgs = async (root, rootPkg) => {
   return wsPkgs
 }
 
-const getPkgs = async (root) => {
+const getPkgs = async root => {
   log.verbose('get-pkgs', 'root', root)
 
   const rootPkg = await getPkg(root)

package/lib/release/changelog.js

@@ -11,7 +11,7 @@ class Changelog {
     [Changelog.BREAKING]: '⚠️ BREAKING CHANGES',
   }
 
-  constructor ({ version, url, sections }) {
+  constructor({ version, url, sections }) {
     this.#title = `## ${url ? link(version, url) : version} (${formatDate()})`
     for (const section of sections) {
       this.#types.add(section.type)
@@ -20,7 +20,7 @@ class Changelog {
     }
   }
 
-  add (type, ...entries) {
+  add(type, ...entries) {
     if (!this.#types.has(type) || !entries.length) {
       return
     }
@@ -28,29 +28,29 @@ class Changelog {
     this.#entries[type].push(...entries)
   }
 
-  #getEntries (type) {
-    const section = this.#sections[type]
-    const entries = this.#entries[type].map(list)
-    // Ignoring coverage until we use this again
-    /* istanbul ignore next */
-    if (section?.collapse) {
-      entries.unshift('<details><summary>Commits</summary>\n')
-      entries.push('\n</details>')
-    }
-    return entries.join('\n')
+  #getEntries(type) {
+    return this.#entries[type].map(list).join('\n')
   }
 
-  toString () {
+  toString() {
     const body = [this.#title]
+    const includedTypes = []
+
     for (const type of this.#types) {
-      const title = this.#titles[type]
       if (this.#entries[type]?.length) {
-        body.push(
-          `### ${title}`,
-          this.#getEntries(type)
-        )
+        includedTypes.push(type)
+        body.push(`### ${this.#titles[type]}`, this.#getEntries(type))
       }
     }
+
+    // If every commit is from a hidden section then we return an
+    // empty string which will skip the release PR being created.
+    // We do this because we don't want PRs opened if they only contain
+    // chores but we do want to rebuild existing PRs if chores are added.
+    if (includedTypes.every(type => this.#sections[type]?.hidden)) {
+      return ''
+    }
+
     return body.join('\n\n').trim()
   }
 }
@@ -62,7 +62,7 @@ class ChangelogNotes {
   #graphql
   #ghUrl
 
-  constructor (github) {
+  constructor(github) {
     this.#owner = github.repository.owner
     this.#repo = github.repository.repo
     this.#rest = github.octokit.rest
@@ -70,7 +70,7 @@ class ChangelogNotes {
     this.#ghUrl = makeGitHubUrl(this.#owner, this.#repo)
   }
 
-  async #getAuthorsForCommits (commits) {
+  async #getAuthorsForCommits(commits) {
     const shas = commits
       .filter(c => c.type !== 'deps')
       .map(c => c.sha)
@@ -82,7 +82,7 @@ class ChangelogNotes {
 
     const authorsByCommit = {}
     const { repository } = await this.#graphql(
-        `fragment CommitAuthors on GitObject {
+      `fragment CommitAuthors on GitObject {
           ... on Commit {
             authors (first:10) {
               nodes {
@@ -94,23 +94,23 @@ class ChangelogNotes {
         }
         query {
           repository (owner:"${this.#owner}", name:"${this.#repo}") {
-            ${shas.map((s) => {
+            ${shas.map(s => {
               return `_${s}: object (expression: "${s}") { ...CommitAuthors }`
             })}
           }
-        }`
+        }`,
     )
     for (const [key, commit] of Object.entries(repository)) {
       if (commit) {
         authorsByCommit[key.slice(1)] = commit.authors.nodes
-          .map((a) => a.user && a.user.login ? `@${a.user.login}` : a.name)
+          .map(a => (a.user && a.user.login ? `@${a.user.login}` : a.name))
           .filter(Boolean)
       }
     }
     return authorsByCommit
   }
 
-  async #getPullRequestNumbersForCommits (commits) {
+  async #getPullRequestNumbersForCommits(commits) {
     const shas = commits
       .filter(c => !c.pullRequest?.number)
       .map(c => c.sha)
@@ -122,19 +122,20 @@ class ChangelogNotes {
 
     const pullRequestsByCommit = {}
     for (const sha of shas) {
-      pullRequestsByCommit[sha] = await this.#rest.repos.listPullRequestsAssociatedWithCommit({
-        owner: this.#owner,
-        repo: this.#repo,
-        commit_sha: sha,
-        per_page: 1,
-      })
-        .then((r) => r.data[0].number)
+      pullRequestsByCommit[sha] = await this.#rest.repos
+        .listPullRequestsAssociatedWithCommit({
+          owner: this.#owner,
+          repo: this.#repo,
+          commit_sha: sha,
+          per_page: 1,
+        })
+        .then(r => r.data[0].number)
         .catch(() => null)
     }
     return pullRequestsByCommit
   }
 
-  #buildEntry (commit) {
+  #buildEntry(commit) {
     const entry = []
 
     if (commit.sha) {
@@ -161,7 +162,7 @@ class ChangelogNotes {
     return entry.join(' ')
   }
 
-  #filterCommits (commits) {
+  #filterCommits(commits) {
     const filteredCommits = []
     const keyedDuplicates = {}
 
@@ -186,8 +187,8 @@ class ChangelogNotes {
     // Sort all our duplicates so we get the latest verion (by PR number) of each type.
     // Then flatten so we can put them all back into the changelog
     const sortedDupes = Object.values(keyedDuplicates)
-      .filter((items) => Boolean(items.length))
-      .map((items) => items.sort((a, b) => b.pullRequestNumber - a.pullRequestNumber))
+      .filter(items => Boolean(items.length))
+      .map(items => items.sort((a, b) => b.pullRequestNumber - a.pullRequestNumber))
       .flatMap(items => items[0])
 
     // This moves them to the bottom of their changelog section which is not
@@ -199,7 +200,7 @@ class ChangelogNotes {
     return filteredCommits
   }
 
-  async buildNotes (rawCommits, { version, previousTag, currentTag, changelogSections }) {
+  async buildNotes(rawCommits, { version, previousTag, currentTag, changelogSections }) {
     // get authors for commits for each sha
     const authors = await this.#getAuthorsForCommits(rawCommits)
 
@@ -208,7 +209,7 @@ class ChangelogNotes {
     // lookup commits without a pr number and find one if it exists
     const prNumbers = await this.#getPullRequestNumbersForCommits(rawCommits)
 
-    const fullCommits = rawCommits.map((commit) => {
+    const fullCommits = rawCommits.map(commit => {
       commit.authors = authors[commit.sha] ?? []
       commit.pullRequestNumber = Number(commit.pullRequest?.number ?? prNumbers[commit.sha])
       return commit
@@ -216,9 +217,7 @@ class ChangelogNotes {
 
     const changelog = new Changelog({
       version,
-      url: previousTag
-        ? this.#ghUrl('compare', `${previousTag.toString()}...${currentTag.toString()}`)
-        : null,
+      url: previousTag ? this.#ghUrl('compare', `${previousTag.toString()}...${currentTag.toString()}`) : null,
       sections: changelogSections,
     })
 
@@ -227,9 +226,7 @@ class ChangelogNotes {
       changelog.add(commit.type, this.#buildEntry(commit))
 
       // And breaking changes to its own section
-      changelog.add(Changelog.BREAKING, ...commit.notes
-        .filter(n => n.title === 'BREAKING CHANGE')
-        .map(n => n.text))
+      changelog.add(Changelog.BREAKING, ...commit.notes.filter(n => n.title === 'BREAKING CHANGE').map(n => n.text))
     }
 
     return changelog.toString()