@npmcli/template-oss 4.18.1 → 4.20.0

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.18.1",
+  "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"

package/lib/content/_step-node.yml

@@ -1,57 +0,0 @@
-- name: Setup Node
-  uses: actions/setup-node@v3
-  id: node
-  with:
-    node-version: {{#if jobIsMatrix}}$\{{ matrix.node-version }}{{else}}{{ last ciVersions }}{{/if}}
-    check-latest: contains({{#if jobIsMatrix}}matrix.node-version{{else}}'{{ last ciVersions }}'{{/if}}, '.x')
-    {{#if lockfile}}
-    cache: npm
-    {{/if}}
-
-{{#if updateNpm}}
-# node 10/12/14 ship with npm@6, which is known to fail when updating itself in windows
-- name: Update Windows npm
-  if: |
-    matrix.platform.os == 'windows-latest' && (
-      startsWith(steps.node.outputs.node-version, 'v10.') || startsWith(steps.node.outputs.node-version, 'v12.') || startsWith(steps.node.outputs.node-version, 'v14.')
-    )
-  run: |
-    curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
-    tar xf npm-7.5.4.tgz
-    cd package
-    node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
-    cd ..
-    rmdir /s /q package
-
-# Start on Node 10 because we dont test on anything lower
-- name: Install npm@7 on Node 10
-  shell: bash
-  if: startsWith(steps.node.outputs.node-version, 'v10.')
-  id: npm-7
-  run: |
-    npm i --prefer-online --no-fund --no-audit -g npm@7
-    echo "updated=true" >> "$GITHUB_OUTPUT"
-
-- name: Install npm@8 on Node 12
-  shell: bash
-  if: startsWith(steps.node.outputs.node-version, 'v12.')
-  id: npm-8
-  run: |
-    npm i --prefer-online --no-fund --no-audit -g npm@8
-    echo "updated=true" >> "$GITHUB_OUTPUT"
-
-- name: Install npm@9 on Node 14/16/18.0
-  shell: bash
-  if: startsWith(steps.node.outputs.node-version, 'v14.') || startsWith(steps.node.outputs.node-version, 'v16.') || startsWith(steps.node.outputs.node-version, 'v18.0.')
-  id: npm-9
-  run: |
-    npm i --prefer-online --no-fund --no-audit -g npm@9
-    echo "updated=true" >> "$GITHUB_OUTPUT"
-
-- name: Install npm@latest on Node
-  if: $\{{ !(steps.npm-7.outputs.updated || steps.npm-8.outputs.updated || steps.npm-9.outputs.updated) }}
-  run: npm i --prefer-online --no-fund --no-audit -g npm@latest
-
-- name: npm Version
-  run: npm -v
-{{/if}}

package/lib/content/_steps-setup.yml

@@ -1,6 +0,0 @@
-{{~#if jobCheck}}{{> stepChecks }}{{/if}}
-{{~#unless jobSkipSetup}}
-{{> stepGit }}
-{{> stepNode }}
-{{> stepDeps }}
-{{/unless}}

package/lib/content/ci.yml

@@ -1,13 +0,0 @@
-name: CI {{~#if isWorkspace}} - {{ pkgName }}{{/if}}
-
-on:
-  {{> onCi }}
-
-jobs:
-  lint:
-    {{> job jobName="Lint" }}
-      {{> stepLint jobRunFlags=pkgFlags }}
-
-  test:
-    {{> jobMatrix jobName="Test" }}
-      {{> stepTest jobRunFlags=pkgFlags }}

package/lib/util/parse-ci-versions.js

@@ -1,78 +0,0 @@
-const semver = require('semver')
-const { partition, uniq, groupBy } = require('lodash')
-
-// try to parse a version. if its invalid then
-// try to parse it as a range instead
-const versionOrRange = (v) => semver.parse(v) || new semver.Range(v)
-
-// get the version or the upper bound of the range
-// used for sorting to give the latest ci target
-const getMaxVersion = (v) => v.version || v.set[0][1].semver.version
-
-// given an array of versions, returns an object where
-// each key is a major and each value is a sorted list of versions
-const versionsByMajor = (versions) => {
-  const majors = groupBy(versions, (v) => semver.major(v))
-  for (const [k, vs] of Object.entries(majors)) {
-    majors[k] = semver.sort(vs)[0]
-  }
-  return majors
-}
-
-// given a list of semver ci targets like:
-// ['12.13.0', '12.x', '14.15.0', '14.x', '16.0.0', '16.x']
-// this will parse into a uniq list of lowest "supported"
-// versions. In our cases so that will return
-// '^12.13.0 || ^14.15.0 || >=16'. This is not super generic but fits
-// our use case for now where we want to test on a bunch of
-// specific versions/ranges and map them to somewhat loose
-// semver range for package.json#engines.node. This only supports
-// returning ^ ranges and makes the last version >= currently.
-//
-// Assumptions:
-// - ranges span a single major version
-// - specific versions are lower then the upper bound of
-//   ranges within the same major version
-const parseCITargets = (targets = []) => {
-  const [versions, ranges] = partition(
-    targets.map((t) => versionOrRange(t)),
-    (t) => t.version
-  )
-
-  const sorted = [...versions, ...ranges]
-    .sort((a, b) => semver.compareBuild(getMaxVersion(a), getMaxVersion(b)))
-    .map((v) => v.version || v.raw)
-
-  // object of {major: lowestVersion } for all passed in versions
-  const minVersions = versionsByMajor(versions)
-
-  // object of {major: lowestVersionInRange } for all passed in ranges
-  const minRanges = versionsByMajor(ranges.map((r) => semver.minVersion(r)))
-
-  // Given all the uniq major versions in targets...
-  const parsedRanges = uniq([...Object.keys(minVersions), ...Object.keys(minRanges)])
-    // first sort by major to make it display nicer
-    .sort((a, b) => Number(a) - Number(b))
-    .map((major) => {
-      const minVersion = minVersions[major]
-      const minRange = minRanges[major]
-      // if we only have one then return that
-      if (!minVersion || !minRange) {
-        return minVersion || minRange
-      }
-      // otherwise return min version
-      // XXX: this assumes the versions are lower than the upper
-      // bound for any range for the same major. This is ok for
-      // now but will break with more complex/specific semver ranges
-      return minVersion
-    })
-    // make the last version allow all greater than
-    .map((v, index, list) => (index === list.length - 1 ? '>=' : '^') + v)
-
-  return {
-    targets: sorted,
-    engines: parsedRanges.join(' || '),
-  }
-}
-
-module.exports = parseCITargets