@npmcli/template-oss 4.3.2 → 4.4.0

package/lib/content/_on-ci.yml

@@ -6,7 +6,7 @@ pull_request:
   {{/if}}
   {{#if isRootMono}}
   paths-ignore:
-    {{#each workspaceGlob}}
+    {{#each workspaceGlobs}}
     - {{ . }}
     {{/each}}
   {{/if}}
@@ -21,7 +21,7 @@ push:
   {{/if}}
   {{#if isRootMono}}
   paths-ignore:
-    {{#each workspaceGlob}}
+    {{#each workspaceGlobs}}
     - {{ . }}
     {{/each}}
   {{/if}}

package/lib/content/ci.yml

@@ -4,6 +4,15 @@ on:
   {{> onCi }}
 
 jobs:
+  engines:
+    {{> jobMatrix
+      jobName="Engines"
+      jobDepFlags="--engines-strict"
+      macCI=false
+      windowsCI=false
+      ciVersions=(reject ciVersions '\.x$')
+    }}
+
   lint:
     {{> job jobName="Lint" }}
       {{> stepLint jobRunFlags=pkgFlags }}

package/lib/content/pkg.json

@@ -33,7 +33,7 @@
   "standard": {{{ del }}},
   "tap": {
     {{#if workspacePaths}}
-    "test-ignore": "^({{ join workspacePaths "|" }})/**",
+    "test-ignore": "^({{ join workspacePaths "|" }})/",
     {{/if}}
     "nyc-arg": [
       {{#each workspaceGlobs}}

package/lib/content/post-dependabot.yml

@@ -39,6 +39,15 @@ jobs:
           if [[ `git status --porcelain` ]]; then
             echo "::set-output name=changes::true"
           fi
+          # This only sets the conventional commit prefix. This workflow can't reliably determine
+          # what the breaking change is though. If a BREAKING CHANGE message is required then
+          # this PR check will fail and the commit will be amended with stafftools
+          if [[ "$\{{ steps.dependabot-metadata.outputs.update-type }}" == "version-update:semver-major" ]]; then
+            prefix='feat!'
+          else
+            prefix='chore!'
+          fi
+          echo "::set-output name=message::$prefix: postinstall for dependabot template-oss PR"
 
       # This step will fail if template-oss has made any workflow updates. It is impossible
       # for a workflow to update other workflows. In the case it does fail, we continue
@@ -50,21 +59,40 @@ jobs:
         env:
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
-          git commit -am "chore: postinstall for dependabot template-oss PR"
+          git commit -am "$\{{ steps.apply.outputs.message }}"
           git push
-
-      - name: Push All Changes Except Workflows
-        if: steps.push.outcome == 'failure'
+      
+      # If the previous step failed, then reset the commit and remove any workflow changes
+      # and attempt to commit and push again. This is helpful because we will have a commit
+      # with the correct prefix that we can then --amend with @npmcli/stafftools later.
+      - name: Commit and push all changes except workflows
+        if: steps.apply.outputs.changes && steps.push-all.outcome == 'failure'
         env:
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
           git reset HEAD~
           git checkout HEAD -- .github/workflows/
           git clean -fd .github/workflows/
-          git commit -am "chore: postinstall for dependabot template-oss PR"
+          git commit -am "$\{{ steps.apply.outputs.message }}"
           git push
 
+      # Check if all the necessary template-oss changes were applied. Since we continued
+      # on errors in one of the previous steps, this check will fail if our follow up
+      # only applied a portion of the changes and we need to followup manually.
+      #
+      # Note that this used to run `lint` and `postlint` but that will fail this action
+      # if we've also shipped any linting changes separate from template-oss. We do
+      # linting in another action, so we want to fail this one only if there are
+      # template-oss changes that could not be applied.
       - name: Check Changes
         if: steps.apply.outputs.changes
         run: |
           {{ rootNpmPath }} exec --offline $\{{ steps.flags.outputs.workspace }} -- template-oss-check
+
+      - name: Fail on Breaking Change
+        if: steps.apply.outputs.changes && startsWith(steps.apply.outputs.message, 'feat!')
+        run: |
+          echo "This PR has a breaking change. Run 'npx -p @npmcli/stafftools gh template-oss-fix'"
+          echo "for more information on how to fix this with a BREAKING CHANGE footer."
+          exit 1
+          

package/lib/util/template.js

@@ -10,30 +10,33 @@ const partialName = (s) => basename(s, extname(s)) // remove extension
   .replace(/^_/, '') // remove leading underscore
   .replace(/-([a-z])/g, (_, g) => g.toUpperCase()) // camelcase
 
-const setupHandlebars = (...partialDirs) => {
+const makePartials = (dir, setDefault) => {
+  const partials = fs.readdirSync(dir).reduce((acc, f) => {
+    const partial = fs.readFileSync(join(dir, f)).toString()
+    const name = partialName(f)
+    acc[name] = partial
+    if (setDefault && f.startsWith('_')) {
+      acc[partialName(`default-${name}`)] = partial
+    }
+    return acc
+  }, {})
+
+  Handlebars.registerPartial(partials)
+}
+
+const setupHandlebars = (baseDir, ...otherDirs) => {
   Handlebars.registerHelper('obj', ({ hash }) => Object.fromEntries(safeValues(hash)))
   Handlebars.registerHelper('join', (arr, sep) => arr.join(typeof sep === 'string' ? sep : ', '))
   Handlebars.registerHelper('pluck', (arr, key) => arr.map(a => a[key]))
+  Handlebars.registerHelper('reject', (arr, re) => arr.filter(a => !new RegExp(re).test(a)))
   Handlebars.registerHelper('quote', (arr) => arr.map(a => `'${a}'`))
   Handlebars.registerHelper('last', (arr) => arr[arr.length - 1])
   Handlebars.registerHelper('json', (c) => JSON.stringify(c))
   Handlebars.registerHelper('del', () => JSON.stringify(DELETE))
 
-  // Load all files as camelcase partial names.
-  // all other content dirs only get special underscore leading
-  // files as partials. this prevents recursion loops when overwriting
-  // a filename to use as a enw file
-  let isBase = true
-  for (const dir of partialDirs) {
-    for (const f of fs.readdirSync(dir)) {
-      if (f.startsWith('_') || isBase) {
-        Handlebars.registerPartial(
-          partialName(f),
-          fs.readFileSync(join(dir, f)).toString()
-        )
-      }
-    }
-    isBase = false
+  makePartials(baseDir, true)
+  for (const dir of otherDirs) {
+    makePartials(dir)
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.3.2",
+  "version": "4.4.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {