@npmcli/template-oss 4.19.0 → 4.20.0

package/lib/content/index.js

@@ -5,46 +5,47 @@ const isPublic = (p) => p.config.isPublic
 const sharedRootAdd = (name) => ({
   // release
   '.github/workflows/release.yml': {
-    file: 'release.yml',
+    file: 'release-yml.hbs',
     filter: isPublic,
   },
   '.github/workflows/ci-release.yml': {
-    file: 'ci-release.yml',
+    file: 'ci-release-yml.hbs',
     filter: isPublic,
   },
   '.release-please-manifest.json': {
-    file: 'release-please-manifest.json',
+    file: 'release-please-manifest-json.hbs',
     filter: isPublic,
-    parser: (p) => class extends p.JsonMerge {
-      comment = null
-    },
+    parser: (p) => p.JsonMergeNoComment,
   },
   'release-please-config.json': {
-    file: 'release-please-config.json',
+    file: 'release-please-config-json.hbs',
     filter: isPublic,
-    parser: (p) => class extends p.JsonMerge {
-      comment = null
-    },
+    parser: (p) => p.JsonMergeNoComment,
+  },
+  'tsconfig.json': {
+    file: 'tsconfig-json.hbs',
+    filter: (p) => p.config.typescript,
+    parser: (p) => p.JsonMergeNoComment,
   },
   // this lint commits which is only necessary for releases
   '.github/workflows/pull-request.yml': {
-    file: 'pull-request.yml',
+    file: 'pull-request-yml.hbs',
     filter: isPublic,
   },
   // ci
-  '.github/matchers/tap.json': 'tap.json',
-  [`.github/workflows/ci${name ? `-${name}` : ''}.yml`]: 'ci.yml',
+  '.github/matchers/tap.json': 'tap-json.hbs',
+  [`.github/workflows/ci${name ? `-${name}` : ''}.yml`]: 'ci-yml.hbs',
   // dependabot
   '.github/dependabot.yml': {
-    file: 'dependabot.yml',
+    file: 'dependabot-yml.hbs',
     filter: (p) => p.config.dependabot,
   },
   '.github/workflows/post-dependabot.yml': {
-    file: 'post-dependabot.yml',
+    file: 'post-dependabot-yml.hbs',
     filter: (p) => p.config.dependabot,
   },
   '.github/settings.yml': {
-    file: 'settings.yml',
+    file: 'settings-yml.hbs',
     filter: (p) => !p.config.isReleaseBranch,
   },
 })
@@ -61,15 +62,16 @@ const sharedRootRm = () => ({
 // Changes applied to the root of the repo
 const rootRepo = {
   add: {
-    '.commitlintrc.js': 'commitlintrc.js',
-    '.github/ISSUE_TEMPLATE/bug.yml': 'bug.yml',
-    '.github/ISSUE_TEMPLATE/config.yml': 'config.yml',
-    '.github/CODEOWNERS': 'CODEOWNERS',
-    '.github/workflows/audit.yml': 'audit.yml',
-    '.github/workflows/codeql-analysis.yml': 'codeql-analysis.yml',
+    '.commitlintrc.{{ cjsExt }}': 'commitlintrc-js.hbs',
+    '.github/ISSUE_TEMPLATE/bug.yml': 'bug-yml.hbs',
+    '.github/ISSUE_TEMPLATE/config.yml': 'config-yml.hbs',
+    '.github/CODEOWNERS': 'CODEOWNERS.hbs',
+    '.github/workflows/audit.yml': 'audit-yml.hbs',
+    '.github/workflows/codeql-analysis.yml': 'codeql-analysis-yml.hbs',
     ...sharedRootAdd(),
   },
   rm: {
+    '.commitlintrc.{{ deleteJsExt }}': true,
     '.github/workflows/release-test.yml': true,
     '.github/workflows/release-please.yml': true,
     ...sharedRootRm(),
@@ -83,19 +85,19 @@ const rootRepo = {
 // dir. so we might want to combine these
 const rootModule = {
   add: {
-    '.eslintrc.js': {
-      file: 'eslintrc.js',
+    '.eslintrc.{{ cjsExt }}': {
+      file: 'eslintrc-js.hbs',
       filter: (p) => p.config.eslint,
     },
-    '.gitignore': 'gitignore',
-    '.npmrc': 'npmrc',
-    'SECURITY.md': 'SECURITY.md',
-    'CODE_OF_CONDUCT.md': 'CODE_OF_CONDUCT.md',
-    'CONTRIBUTING.md': 'CONTRIBUTING.md',
-    'package.json': 'pkg.json',
+    '.gitignore': 'gitignore.hbs',
+    '.npmrc': 'npmrc.hbs',
+    'SECURITY.md': 'SECURITY-md.hbs',
+    'CODE_OF_CONDUCT.md': 'CODE_OF_CONDUCT-md.hbs',
+    'CONTRIBUTING.md': 'CONTRIBUTING-md.hbs',
+    'package.json': 'package-json.hbs',
   },
   rm: [
-    '.eslintrc.!(js|local.*)',
+    '.eslintrc.!({{ cjsExt }}|local.*)',
   ],
 }
 
@@ -114,16 +116,16 @@ const workspaceRepo = {
 // Changes for each workspace but applied to the relative workspace dir
 const workspaceModule = {
   add: {
-    '.eslintrc.js': {
-      file: 'eslintrc.js',
+    '.eslintrc.{{ cjsExt }}': {
+      file: 'eslintrc-js.hbs',
       filter: (p) => p.config.eslint,
     },
-    '.gitignore': 'gitignore',
-    'package.json': 'pkg.json',
+    '.gitignore': 'gitignore.hbs',
+    'package.json': 'package-json.hbs',
   },
   rm: [
     '.npmrc',
-    '.eslintrc.!(js|local.*)',
+    '.eslintrc.!({{ cjsExt }}|local.*)',
     'SECURITY.md',
   ],
 }
@@ -144,8 +146,6 @@ module.exports = {
     'lib/',
   ],
   allowPaths: [
-    '/bin/',
-    '/lib/',
     '/.eslintrc.local.*',
     '**/.gitignore',
     '/docs/',
@@ -157,13 +157,17 @@ module.exports = {
     '/LICENSE*',
     '/CHANGELOG*',
   ],
-  ignorePaths: [],
+  ignorePaths: [
+    /* to be provided by consuming package */
+  ],
   ciVersions: {},
   latestCiVersion: 20,
   lockfile: false,
   codeowner: '@npm/cli-team',
   eslint: true,
   publish: false,
+  typescript: false,
+  esm: false,
   updateNpm: true,
   dependabot: 'increase-if-necessary',
   unwantedPackages: [

package/lib/content/{pkg.json → package-json.hbs}

@@ -1,8 +1,9 @@
 {
   "author": "GitHub Inc.",
-  "files": {{{ json distPaths }}},
+  "files": {{#if typescript}}{{{ del }}}{{else}}{{{ json distPaths }}}{{/if}},
+  "type": {{#if esm}}"module"{{else}}{{{ del }}}{{/if}},
   "scripts": {
-    "lint": "{{#if eslint}}eslint \"**/*.js\"{{else}}echo linting disabled{{/if}}",
+    "lint": "{{#if eslint}}eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"{{else}}echo linting disabled{{/if}}",
     "postlint": "template-oss-check",
     "template-oss-apply": "template-oss-apply --force",
     "lintfix": "{{ localNpmPath }} run lint -- --fix",
@@ -13,6 +14,9 @@
     "test-all": "{{ localNpmPath }} run test {{ allFlags }}",
     "lint-all": "{{ localNpmPath }} run lint {{ allFlags }}",
     {{/if}}
+    {{#if typescript}}
+    "prepare": "tshy",
+    {{/if}}
     "template-copy": {{{ del }}},
     "lint:fix": {{{ del }}},
     "preversion": {{{ del }}},
@@ -30,13 +34,13 @@
     {{#if workspacePaths}}
     "test-ignore": "^({{ join workspacePaths "|" }})/",
     {{/if}}
-    "nyc-arg": [
+    "nyc-arg": {{#if tap18}}{{{ del }}}{{else}}[
       {{#each workspaceGlobs}}
       "--exclude",
       "{{ . }}",
       {{/each}}
       "--exclude",
       "tap-snapshots/**"
-    ]
+    ]{{/if}}
   }
 }

package/lib/content/{post-dependabot.yml → post-dependabot-yml.hbs}

@@ -8,7 +8,7 @@ permissions:
 
 jobs:
   template-oss:
-    {{> job
+    {{> jobYml
       jobName="template-oss"
       jobIf="github.actor == 'dependabot[bot]'"
       jobCheckout=(obj ref="${{ github.event.pull_request.head.ref }}")

package/lib/content/{pull-request.yml → pull-request-yml.hbs}

@@ -10,7 +10,7 @@ on:
 
 jobs:
   commitlint:
-    {{> job jobName="Lint Commits" jobCheckout=(obj fetch-depth=0) }}
+    {{> jobYml jobName="Lint Commits" jobCheckout=(obj fetch-depth=0) }}
       - name: Run Commitlint on Commits
         id: commit
         continue-on-error: true

package/lib/content/{release.yml → release-yml.hbs}

@@ -27,7 +27,7 @@ jobs:
       pr-number: $\{{ steps.release.outputs.pr-number }}
       comment-id: $\{{ steps.pr-comment.outputs.result }}
       check-id: $\{{ steps.check.outputs.check_id }}
-    {{> job jobName="Release" }}
+    {{> jobYml jobName="Release" }}
       - name: Release Please
         id: release
         env:
@@ -66,14 +66,14 @@ jobs:
             }
 
             return commentId
-      {{> stepChecks jobCheck=(obj name="Release" sha="steps.release.outputs.pr-sha") }}
+      {{> stepChecksYml jobCheck=(obj name="Release" sha="steps.release.outputs.pr-sha") }}
 
   update:
     needs: release
     outputs:
       sha: $\{{ steps.commit.outputs.sha }}
       check-id: $\{{ steps.check.outputs.check_id }}
-    {{> job
+    {{> jobYml
       jobName="Update - Release"
       jobIf="needs.release.outputs.pr"
       jobCheckout=(obj ref="${{ needs.release.outputs.branch }}" fetch-depth=0)
@@ -94,8 +94,8 @@ jobs:
           git commit --all --amend --no-edit || true
           git push --force-with-lease
           echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
-      {{> stepChecks jobName="Update - Release" jobCheck=(obj sha="steps.commit.outputs.sha" name="Release" )}}
-      {{> stepChecks jobCheck=(obj id="needs.release.outputs.check-id" )}}
+      {{> stepChecksYml jobName="Update - Release" jobCheck=(obj sha="steps.commit.outputs.sha" name="Release" )}}
+      {{> stepChecksYml jobCheck=(obj id="needs.release.outputs.check-id" )}}
 
   ci:
     name: CI - Release
@@ -108,7 +108,7 @@ jobs:
 
   post-ci:
     needs: [release, update, ci]
-    {{> job jobName="Post CI - Release" jobIf="needs.release.outputs.pr && always()" jobSkipSetup=true }}
+    {{> jobYml jobName="Post CI - Release" jobIf="needs.release.outputs.pr && always()" jobSkipSetup=true }}
       - name: Get Needs Result
         id: needs-result
         run: |
@@ -121,11 +121,11 @@ jobs:
             result="success"
           fi
           echo "result=$result" >> $GITHUB_OUTPUT
-      {{> stepChecks jobCheck=(obj id="needs.update.outputs.check-id" status="steps.needs-result.outputs.result") }}
+      {{> stepChecksYml jobCheck=(obj id="needs.update.outputs.check-id" status="steps.needs-result.outputs.result") }}
 
   post-release:
     needs: release
-    {{> job jobName="Post Release - Release" jobIf="needs.release.outputs.releases" jobSkipSetup=true  }}
+    {{> jobYml jobName="Post Release - Release" jobIf="needs.release.outputs.releases" jobSkipSetup=true  }}
       - name: Create Release PR Comment
         uses: actions/github-script@v6
         env:
@@ -163,11 +163,11 @@ jobs:
     needs: release
     name: Release Integration
     if: needs.release.outputs.release
-    {{> jobReleaseIntegration }}
+    {{> jobReleaseIntegrationYml }}
 
   post-release-integration:
     needs: [release, release-integration]
-    {{> job jobName="Post Release Integration - Release" jobIf="needs.release.outputs.release && always()" jobSkipSetup=true }}
+    {{> jobYml jobName="Post Release Integration - Release" jobIf="needs.release.outputs.release && always()" jobSkipSetup=true }}
       - name: Get Needs Result
         id: needs-result
         run: |

package/lib/content/tsconfig-json.hbs

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "jsx": "react",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "nodenext",
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "es2022",
+    "module": "nodenext"
+  }
+}

package/lib/util/files.js

@@ -1,5 +1,5 @@
 const { join } = require('path')
-const { defaultsDeep, omit } = require('lodash')
+const { defaultsDeep, omit, isPlainObject } = require('lodash')
 const deepMapValues = require('just-deep-map-values')
 const { glob } = require('glob')
 const { mergeWithCustomizers, customizers } = require('./merge.js')
@@ -12,6 +12,11 @@ const FILE_KEYS = ['rootRepo', 'rootModule', 'workspaceRepo', 'workspaceModule']
 
 const globify = pattern => pattern.split('\\').join('/')
 
+const deepMapKeys = (obj, fn) => Object.entries(obj).reduce((acc, [key, value]) => {
+  acc[fn(key)] = isPlainObject(value) ? deepMapKeys(value, fn) : value
+  return acc
+}, {})
+
 const mergeFiles = mergeWithCustomizers((value, srcValue, key, target, source, stack) => {
   // This will merge all files except if the src file has overwrite:false. Then
   // the files will be turned into an array so they can be applied on top of
@@ -35,7 +40,7 @@ const fileEntries = (dir, files, options, { allowMultipleSources = true } = {})
       continue
     }
 
-    // target paths need to be joinsed with dir and templated
+    // target paths need to be joined with dir and templated
     const target = join(dir, template(key, options))
 
     if (Array.isArray(source)) {
@@ -66,7 +71,7 @@ const getParsers = (dir, files, options, parseOptions) => {
     const clean = typeof shouldClean === 'function' ? shouldClean(options) : false
 
     if (parser) {
-    // allow files to extend base parsers or create new ones
+      // allow files to extend base parsers or create new ones
       return new (parser(Parser.Parsers))(target, file, options, { clean })
     }
 
@@ -105,23 +110,27 @@ const parseEach = async (dir, files, options, parseOptions, fn) => {
   return res.filter(Boolean)
 }
 
-const parseConfig = (files, dir, overrides) => {
-  const normalizeFiles = (v) => deepMapValues(v, (value, key) => {
-    if (key === RM_KEY && Array.isArray(value)) {
-      return value.reduce((acc, k) => {
-        acc[k] = true
-        return acc
-      }, {})
-    }
-    if (typeof value === 'string') {
-      const file = join(dir, value)
-      return key === 'file' ? file : { file }
-    }
-    if (value === true && FILE_KEYS.includes(key)) {
-      return {}
-    }
-    return value
-  })
+const parseConfig = (files, dir, overrides, templateSettings) => {
+  const normalizeFiles = (v) => {
+    v = deepMapKeys(v, (s) => template(s, templateSettings))
+    return deepMapValues(v, (value, key) => {
+      if (key === RM_KEY && Array.isArray(value)) {
+        return value.reduce((acc, k) => {
+        // template files nows since they need to be normalized before merging
+          acc[template(k, templateSettings)] = true
+          return acc
+        }, {})
+      }
+      if (typeof value === 'string') {
+        const file = join(dir, value)
+        return key === 'file' ? file : { file }
+      }
+      if (value === true && FILE_KEYS.includes(key)) {
+        return {}
+      }
+      return value
+    })
+  }
 
   const merged = mergeFiles(normalizeFiles(files), normalizeFiles(overrides))
   const withDefaults = defaultsDeep(merged, FILE_KEYS.reduce((acc, k) => {

package/lib/util/get-cmd-path.js

@@ -0,0 +1,36 @@
+const { join, relative } = require('path')
+const { makePosix } = require('./path.js')
+
+const getCmdPath = (key, { pkgConfig, rootConfig, isRoot, pkg, rootPkg }) => {
+  const result = (local, isRelative) => {
+    let root = local
+    const isLocal = local.startsWith('.') || local.startsWith('/')
+
+    if (isLocal) {
+      if (isRelative) {
+        // Make a path relative from a workspace to the root if we are in a workspace
+        local = makePosix(join(relative(pkg.path, rootPkg.path), local))
+      }
+      local = `node ${local}`
+      root = `node ${root}`
+    }
+
+    return {
+      isLocal,
+      local,
+      root,
+    }
+  }
+
+  if (pkgConfig[key]) {
+    return result(pkgConfig[key])
+  }
+
+  if (rootConfig[key]) {
+    return result(rootConfig[key], !isRoot)
+  }
+
+  return result(key)
+}
+
+module.exports = getCmdPath

package/lib/util/git.js

@@ -19,9 +19,9 @@ const tryGit = async (path, ...args) => {
 
 // parse a repo from a git origin into a format
 // for a package.json#repository object
-const getUrl = async (path) => {
+const getRemoteUrl = async (path, remote) => {
   try {
-    const urlStr = await tryGit(path, 'remote', 'get-url', 'origin')
+    const urlStr = await tryGit(path, 'remote', 'get-url', remote)
     const { domain, user, project } = hgi.fromUrl(urlStr)
     const url = new URL(`https://${domain}`)
     url.pathname = `/${user}/${project}.git`
@@ -31,6 +31,10 @@ const getUrl = async (path) => {
   }
 }
 
+const getUrl = async (path) => {
+  return (await getRemoteUrl(path, 'upstream')) ?? (await getRemoteUrl(path, 'origin'))
+}
+
 const getBranches = async (path, branchPatterns) => {
   let matchingBranches = new Set()
   let matchingPatterns = new Set()

package/lib/util/import-or-require.js

@@ -0,0 +1,29 @@
+// This fixes weird behavior I was seeing where calls to require(path) would
+// fail the first time and then fetch via dynamic import which is correct, but
+// then subsequent requires for the same path would return an empty object. Not
+// sure if a bug or I'm doing something wrong but since the require/imports here
+// are short lived, it is safe to create our own cache and use that.
+const { pathToFileURL } = require('url')
+
+const importOrRequireCache = new Map()
+
+const importOrRequire = async (path) => {
+  if (importOrRequireCache.has(path)) {
+    return importOrRequireCache.get(path)
+  }
+  let content = {}
+  try {
+    content = require(path)
+  } catch {
+    try {
+      content = await import(pathToFileURL(path)).then(r => r.default)
+    } catch {
+      // its ok if this fails since the content dir might only be to provide
+      // other files. the index.js is optional
+    }
+  }
+  importOrRequireCache.set(path, content)
+  return content
+}
+
+module.exports = importOrRequire

package/lib/util/parser.js

@@ -173,7 +173,7 @@ class Gitignore extends Base {
 }
 
 class Js extends Base {
-  static types = ['*.js']
+  static types = ['*.js', '*.cjs']
   comment = (c) => `/* ${c} */`
 }
 
@@ -306,6 +306,10 @@ class JsonMerge extends Json {
   merge = (t, s) => merge(t, s)
 }
 
+class JsonMergeNoComment extends JsonMerge {
+  comment = null
+}
+
 class PackageJson extends JsonMerge {
   static types = ['package.json']
 
@@ -346,6 +350,7 @@ const Parsers = {
   YmlMerge,
   Json,
   JsonMerge,
+  JsonMergeNoComment,
   PackageJson,
 }
 

package/lib/util/path.js

@@ -0,0 +1,13 @@
+const { posix, win32 } = require('path')
+
+const makePosix = (v) => v.split(win32.sep).join(posix.sep)
+const deglob = (v) => makePosix(v).replace(/[/*]+$/, '')
+const posixDir = (v) => `${v === '.' ? '' : deglob(v).replace(/\/$/, '')}${posix.sep}`
+const posixGlob = (str) => `${posixDir(str)}**`
+
+module.exports = {
+  makePosix,
+  deglob,
+  posixDir,
+  posixGlob,
+}

package/lib/util/template.js

@@ -31,7 +31,7 @@ const makePartials = (dir, isBase) => {
   Handlebars.registerPartial(partials)
 }
 
-const setupHandlebars = (baseDir, ...otherDirs) => {
+const setupHandlebars = (dirs) => {
   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]))
@@ -40,14 +40,17 @@ const setupHandlebars = (baseDir, ...otherDirs) => {
   Handlebars.registerHelper('json', (c) => JSON.stringify(c))
   Handlebars.registerHelper('del', () => JSON.stringify(DELETE))
 
-  makePartials(baseDir, true)
-  for (const dir of otherDirs) {
-    makePartials(dir)
+  if (Array.isArray(dirs)) {
+    const [baseDir, ...otherDirs] = dirs
+    makePartials(baseDir, true)
+    for (const dir of otherDirs) {
+      makePartials(dir)
+    }
   }
 }
 
-const template = (str, { config, ...options }) => {
-  setupHandlebars(...config.__PARTIAL_DIRS__)
+const template = (str, { config = {}, ...options }) => {
+  setupHandlebars(config.__PARTIAL_DIRS__)
 
   const t = Handlebars.compile(str, { strict: true })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.19.0",
+  "version": "4.20.0",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -10,7 +10,7 @@
     "template-oss-release-manager": "bin/release-manager.js"
   },
   "scripts": {
-    "lint": "eslint \"**/*.js\"",
+    "lint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"",
     "lintfix": "npm run lint -- --fix",
     "posttest": "npm run lint",
     "snap": "tap",
@@ -33,25 +33,25 @@
   "license": "ISC",
   "dependencies": {
     "@actions/core": "^1.9.1",
-    "@commitlint/cli": "^17.1.1",
-    "@commitlint/config-conventional": "^17.1.0",
+    "@commitlint/cli": "^18.2.0",
+    "@commitlint/config-conventional": "^18.1.0",
     "@isaacs/string-locale-compare": "^1.1.0",
-    "@npmcli/arborist": "^6.0.0",
-    "@npmcli/git": "^4.0.0",
+    "@npmcli/arborist": "^7.2.1",
+    "@npmcli/git": "^5.0.3",
     "@npmcli/map-workspaces": "^3.0.0",
-    "@npmcli/package-json": "^4.0.0",
+    "@npmcli/package-json": "^5.0.0",
     "@octokit/rest": "^19.0.4",
     "diff": "^5.0.0",
     "glob": "^10.1.0",
     "handlebars": "^4.7.7",
-    "hosted-git-info": "^6.0.0",
+    "hosted-git-info": "^7.0.1",
     "ini": "^4.0.0",
     "json-parse-even-better-errors": "^3.0.0",
     "just-deep-map-values": "^1.1.1",
     "just-diff": "^6.0.0",
     "lodash": "^4.17.21",
     "minimatch": "^9.0.2",
-    "npm-package-arg": "^10.0.0",
+    "npm-package-arg": "^11.0.1",
     "proc-log": "^3.0.0",
     "release-please": "npm:@npmcli/release-please@^14.2.6",
     "semver": "^7.3.5",
@@ -81,7 +81,7 @@
     "publish": true
   },
   "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+    "node": "^18.17.0 || >=20.5.0"
   },
   "workspaces": [
     "workspace/test-workspace"