@npmcli/template-oss 4.22.0 → 4.23.1

package/lib/util/has-package.js

@@ -39,16 +39,11 @@ const getSpecVersion = (spec, where) => {
   return null
 }
 
-const isVersion = (s) => s instanceof semver.SemVer
+const isVersion = s => s instanceof semver.SemVer
 
 // Returns whether the pkg has the dependency in a semver
 // compatible version in one or more locationscccc
-const hasPackage = (
-  pkg,
-  spec,
-  locations = installLocations,
-  path
-) => {
+const hasPackage = (pkg, spec, locations = installLocations, path) => {
   const name = npa(spec).name
   const requested = getSpecVersion(spec)
 
@@ -57,16 +52,16 @@ const hasPackage = (
   }
 
   const existingByLocation = locations
-    .map((location) => pkg[location])
-    .filter((deps) => has(deps, name))
-    .map((deps) => getSpecVersion(`${name}@${deps[name]}`, path))
+    .map(location => pkg[location])
+    .filter(deps => has(deps, name))
+    .map(deps => getSpecVersion(`${name}@${deps[name]}`, path))
     .filter(Boolean)
 
-  return existingByLocation.some((existing) => {
+  return existingByLocation.some(existing => {
     if (existing === true) {
       return true
     }
-    switch ([existing, requested].map((t) => isVersion(t) ? 'VER' : 'RNG').join('-')) {
+    switch ([existing, requested].map(t => (isVersion(t) ? 'VER' : 'RNG')).join('-')) {
       case `VER-VER`:
         // two versions, use semver.eq to check equality
         return semver.eq(existing, requested)

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

@@ -7,7 +7,7 @@ const { pathToFileURL } = require('url')
 
 const importOrRequireCache = new Map()
 
-const importOrRequire = async (path) => {
+const importOrRequire = async path => {
   if (importOrRequireCache.has(path)) {
     return importOrRequireCache.get(path)
   }

package/lib/util/json-diff.js

@@ -6,28 +6,29 @@ const j = (obj, replacer = null) => JSON.stringify(obj, replacer, 2)
 
 // DELETE is a special string that will be the value of updated if it exists
 // but should be deleted
-const jsonDiff = (s1, s2, DELETE) => diff(s1, s2)
-  .map(({ op, path, value }) => {
-    // there could be cases where a whole object is reported
-    // as missing and the expected value does not need to show
-    // special DELETED values so filter those out here
-    const msgVal = j(value, (_, v) => v === DELETE ? undefined : v)
-    const prev = j(get(s1, path))
-    const key = j(path.reduce((acc, p) => acc + (typeof p === 'number' ? `[${p}]` : `.${p}`)))
+const jsonDiff = (s1, s2, DELETE) =>
+  diff(s1, s2)
+    .map(({ op, path, value }) => {
+      // there could be cases where a whole object is reported
+      // as missing and the expected value does not need to show
+      // special DELETED values so filter those out here
+      const msgVal = j(value, (_, v) => (v === DELETE ? undefined : v))
+      const prev = j(get(s1, path))
+      const key = j(path.reduce((acc, p) => acc + (typeof p === 'number' ? `[${p}]` : `.${p}`)))
 
-    const msg = (...args) => format('%s is %s, expected %s', ...args)
-    const AD = msg(key, 'missing', msgVal)
-    const RM = msg(key, prev, 'to be removed')
-    const UP = msg(key, prev, msgVal)
+      const msg = (...args) => format('%s is %s, expected %s', ...args)
+      const AD = msg(key, 'missing', msgVal)
+      const RM = msg(key, prev, 'to be removed')
+      const UP = msg(key, prev, msgVal)
 
-    if (op === 'replace') {
-      return value === DELETE ? RM : UP
-    } else if (op === 'add' && value !== DELETE) {
-      return AD
-    }
-  })
-  .filter(Boolean)
-  .sort((a, b) => a.localeCompare(b))
-  .join('\n')
+      if (op === 'replace') {
+        return value === DELETE ? RM : UP
+      } else if (op === 'add' && value !== DELETE) {
+        return AD
+      }
+    })
+    .filter(Boolean)
+    .sort((a, b) => a.localeCompare(b))
+    .join('\n')
 
 module.exports = jsonDiff

package/lib/util/merge.js

@@ -32,16 +32,17 @@ const mergeWith = (...args) => {
 
 // Create a merge function that will run a set of customizer functions
 const mergeWithCustomizers = (...customizers) => {
-  return (...objects) => mergeWith({}, ...objects, (...args) => {
-    for (const customizer of customizers) {
-      const result = customizer(...args)
-      // undefined means the customizer will defer to the next one
-      // the default behavior of undefined in lodash is to merge
-      if (result !== undefined) {
-        return result
+  return (...objects) =>
+    mergeWith({}, ...objects, (...args) => {
+      for (const customizer of customizers) {
+        const result = customizer(...args)
+        // undefined means the customizer will defer to the next one
+        // the default behavior of undefined in lodash is to merge
+        if (result !== undefined) {
+          return result
+        }
       }
-    }
-  })
+    })
 }
 
 const customizers = {
@@ -52,14 +53,16 @@ const customizers = {
     }
   },
   // Merge arrays if their key matches one of the passed in keys
-  mergeArrays: (...keys) => (value, srcValue, key) => {
-    if (Array.isArray(srcValue)) {
-      if (keys.includes(key)) {
-        return (Array.isArray(value) ? value : []).concat(srcValue)
+  mergeArrays:
+    (...keys) =>
+    (value, srcValue, key) => {
+      if (Array.isArray(srcValue)) {
+        if (keys.includes(key)) {
+          return (Array.isArray(value) ? value : []).concat(srcValue)
+        }
+        return srcValue
       }
-      return srcValue
-    }
-  },
+    },
 }
 
 module.exports = {

package/lib/util/output.js

@@ -1,8 +1,12 @@
 const indent = (v, i = 2) => {
   if (Array.isArray(v)) {
-    return v.map((a) => indent(a, i)).join('\n')
+    return v.map(a => indent(a, i)).join('\n')
   }
-  return v.toString().split('\n').map((l) => ' '.repeat(i) + l).join('\n')
+  return v
+    .toString()
+    .split('\n')
+    .map(l => ' '.repeat(i) + l)
+    .join('\n')
 }
 
 const output = () => {
@@ -15,13 +19,12 @@ const output = () => {
   }
 }
 
-const outputProblems = (problems) => {
+const outputProblems = problems => {
   const o = output()
   o.push('', 'Some problems were detected:')
   o.sep()
   for (const { title, body, solution } of problems) {
-    const [solutionTitle, ...solutionRest] = Array.isArray(solution)
-      ? solution : [solution]
+    const [solutionTitle, ...solutionRest] = Array.isArray(solution) ? solution : [solution]
     o.push(title, '', indent(body), '', `To correct it: ${solutionTitle}`)
     if (solutionRest.length) {
       o.push('', indent(solutionRest))

package/lib/util/parser.js

@@ -27,7 +27,7 @@ const traverse = (value, visit, keys = []) => {
   }
 }
 
-const fsOk = (code) => (error) => {
+const fsOk = code => error => {
   if (error.code === 'ENOENT') {
     return null
   }
@@ -37,107 +37,114 @@ const fsOk = (code) => (error) => {
 class Base {
   static types = []
   static header = 'This file is automatically added by {{ __NAME__ }}. Do not edit.'
-  comment = (v) => v
+  comment = v => v
   merge = false // supply a merge function which runs on prepare for certain types
   DELETE = template.DELETE
 
-  constructor (target, source, options, fileOptions) {
+  constructor(target, source, options, fileOptions) {
     this.target = target
     this.source = source
     this.options = options
     this.fileOptions = fileOptions
   }
 
-  header () {
+  header() {
     if (typeof this.comment === 'function') {
       return this.comment(this.template(this.constructor.header || ''))
     }
   }
 
-  clean () {
+  clean() {
     if (this.fileOptions.clean) {
       return fs.rm(this.target).catch(fsOk())
     }
     return null
   }
 
-  read (s) {
+  read(s) {
     if (Array.isArray(s)) {
       return Promise.all(s.map(f => this.read(f)))
     }
     return fs.readFile(s, { encoding: 'utf-8' })
   }
 
-  template (s) {
+  template(s) {
     if (Array.isArray(s)) {
       return Promise.all(s.map(f => this.template(f)))
     }
     return template(s, this.options)
   }
 
-  parse (s) {
+  parse(s) {
     return s
   }
 
-  prepare (s) {
+  prepare(s) {
     const header = this.header()
     return header ? `${header}\n\n${s}` : s
   }
 
-  prepareTarget (s) {
+  prepareTarget(s) {
     return s
   }
 
-  toString (s) {
+  toString(s) {
     return s.toString()
   }
 
-  async write (s) {
+  async write(s) {
     // XXX: find more efficient way to do this. we can build all possible dirs before get here
     await fs.mkdir(dirname(this.target), { owner: 'inherit', recursive: true, force: true })
     return fs.writeFile(this.target, this.toString(s), { owner: 'inherit' })
   }
 
-  diffPatch (t, s) {
+  diffPatch(t, s) {
     // create a patch and strip out the filename. if it ends up an empty string
     // then return true since the files are equal
-    return Diff.createPatch('', t.replace(/\r\n/g, '\n'), s.replace(/\r\n/g, '\n'))
-      .split('\n').slice(4).join('\n')
+    return Diff.createPatch('', t.replace(/\r\n/g, '\n'), s.replace(/\r\n/g, '\n')).split('\n').slice(4).join('\n')
   }
 
-  diff (t, s) {
+  diff(t, s) {
     return this.diffPatch(t, s)
   }
 
   // the apply methods are the only ones that should be called publically
   // XXX: everything is allowed to be overridden in base classes but we could
   // find a different solution than making everything public
-  applyWrite () {
-    return Promise.resolve(this.clean())
-      .then(() => this.read(this.source))
-      // replace template vars first, this will throw for nonexistant vars
-      // because it must be parseable after this step
-      .then((s) => this.template(s))
-      // parse into whatever data structure is necessary for maniuplating
-      // diffing, merging, etc. by default its a string
-      .then((s) => {
-        this.sourcePreParse = s
-        return this.parse(s)
-      })
-      // prepare the source for writing and diffing, pass in current
-      // target for merging. errors parsing or preparing targets are ok here
-      .then((s) => this.applyTarget().catch(() => null).then((t) => this.prepare(s, t)))
-      .then((s) => this.write(s))
-  }
-
-  applyTarget () {
-    return Promise.resolve(this.read(this.target))
-      .then((s) => this.parse(s))
-      // for only preparing the target for diffing
-      .then((s) => this.prepareTarget(s))
-  }
-
-  async applyDiff () {
+  applyWrite() {
+    return (
+      Promise.resolve(this.clean())
+        .then(() => this.read(this.source))
+        // replace template vars first, this will throw for nonexistant vars
+        // because it must be parseable after this step
+        .then(s => this.template(s))
+        // parse into whatever data structure is necessary for maniuplating
+        // diffing, merging, etc. by default its a string
+        .then(s => {
+          this.sourcePreParse = s
+          return this.parse(s)
+        })
+        // prepare the source for writing and diffing, pass in current
+        // target for merging. errors parsing or preparing targets are ok here
+        .then(s =>
+          this.applyTarget()
+            .catch(() => null)
+            .then(t => this.prepare(s, t)),
+        )
+        .then(s => this.write(s))
+    )
+  }
+
+  applyTarget() {
+    return (
+      Promise.resolve(this.read(this.target))
+        .then(s => this.parse(s))
+        // for only preparing the target for diffing
+        .then(s => this.prepareTarget(s))
+    )
+  }
+
+  async applyDiff() {
     // handle if old does not exist
     const targetError = 'ETARGETERROR'
     const target = await this.applyTarget().catch(fsOk(targetError))
@@ -148,10 +155,10 @@ class Base {
     }
 
     const source = await Promise.resolve(this.read(this.source))
-      .then((s) => this.template(s))
-      .then((s) => this.parse(s))
+      .then(s => this.template(s))
+      .then(s => this.parse(s))
       // gets the target to diff against in case it needs to merge, etc
-      .then((s) => this.prepare(s, target))
+      .then(s => this.prepare(s, target))
 
     // if there was a target error then there is no need to diff
     // so we just show the source with an error message
@@ -174,28 +181,28 @@ class Base {
 }
 
 class Gitignore extends Base {
-  static types = ['codeowners', '.gitignore']
-  comment = (c) => `# ${c}`
+  static types = ['codeowners', '.gitignore', '.prettierignore']
+  comment = c => `# ${c}`
 }
 
 class Js extends Base {
   static types = ['*.js', '*.cjs']
-  comment = (c) => `/* ${c} */`
+  comment = c => `/* ${c} */`
 }
 
 class Ini extends Base {
   static types = ['*.ini']
-  comment = (c) => `; ${c}`
+  comment = c => `; ${c}`
 
-  toString (s) {
+  toString(s) {
     return typeof s === 'string' ? s : ini.stringify(s)
   }
 
-  parse (s) {
+  parse(s) {
     return typeof s === 'string' ? ini.parse(s) : s
   }
 
-  prepare (s, t) {
+  prepare(s, t) {
     let source = s
     if (typeof this.merge === 'function' && t) {
       source = this.merge(t, s)
@@ -203,7 +210,7 @@ class Ini extends Base {
     return super.prepare(this.toString(source))
   }
 
-  diff (t, s) {
+  diff(t, s) {
     return jsonDiff(this.parse(t), this.parse(s), this.DELETE)
   }
 }
@@ -215,14 +222,14 @@ class IniMerge extends Ini {
 
 class Markdown extends Base {
   static types = ['*.md']
-  comment = (c) => `<!-- ${c} -->`
+  comment = c => `<!-- ${c} -->`
 }
 
 class Yml extends Base {
   static types = ['*.yml']
-  comment = (c) => ` ${c}`
+  comment = c => ` ${c}`
 
-  toString (s) {
+  toString(s) {
     try {
       return s.toString({ lineWidth: 0, indent: 2 })
     } catch (err) {
@@ -231,22 +238,22 @@ class Yml extends Base {
     }
   }
 
-  parse (s) {
+  parse(s) {
     return yaml.parseDocument(s)
   }
 
-  prepare (s) {
+  prepare(s) {
     s.commentBefore = this.header()
     return this.toString(s)
   }
 
-  prepareTarget (s) {
+  prepareTarget(s) {
     return this.toString(s)
   }
 }
 
 class YmlMerge extends Yml {
-  prepare (source, t) {
+  prepare(source, t) {
     if (t === null) {
       // If target does not exist or is in an
       // error state, we cant do anything but write
@@ -256,7 +263,7 @@ class YmlMerge extends Yml {
 
     const key = [].concat(this.key)
 
-    const getId = (node) => {
+    const getId = node => {
       const index = node.items.findIndex(p => p.key?.value === this.id)
       return index !== -1 ? node.items[index].value?.value : node.toJSON()
     }
@@ -284,20 +291,20 @@ class Json extends Base {
   static types = ['*.json']
   // its a json comment! not really but we do add a special key
   // to json objects
-  comment = (c) => ({ [`//${this.options.config.__NAME__}`]: c })
+  comment = c => ({ [`//${this.options.config.__NAME__}`]: c })
 
-  toString (s) {
-    return JSON.stringify(s, (_, v) => v === this.DELETE ? undefined : v, 2).trim() + '\n'
+  toString(s) {
+    return JSON.stringify(s, (_, v) => (v === this.DELETE ? undefined : v), 2).trim() + '\n'
   }
 
-  parse (s) {
+  parse(s) {
     if (Array.isArray(s)) {
       return s.map(f => this.parse(f)).reduce((a, f) => this.merge(a, f), {})
     }
     return jsonParse(s)
   }
 
-  prepare (s, t) {
+  prepare(s, t) {
     let source = s
     if (typeof this.merge === 'function' && t) {
       source = this.merge(t, s)
@@ -305,7 +312,7 @@ class Json extends Base {
     return setFirst(this.header(), source)
   }
 
-  diff (t, s) {
+  diff(t, s) {
     return jsonDiff(t, s, this.DELETE)
   }
 }
@@ -322,7 +329,7 @@ class JsonMergeNoComment extends JsonMerge {
 class PackageJson extends JsonMerge {
   static types = ['package.json']
 
-  async prepare (s, t) {
+  async prepare(s, t) {
     // merge new source with current pkg content
     const update = super.prepare(s, t)
 
@@ -336,7 +343,7 @@ class PackageJson extends JsonMerge {
     return update
   }
 
-  async write (s) {
+  async write(s) {
     const pkg = await NpmPackageJson.load(dirname(this.target))
     pkg.update(s)
     traverse(pkg.content, (keys, value) => {
@@ -378,7 +385,7 @@ for (const parser of Object.values(Parsers)) {
   }
 }
 
-const getParser = (file) => {
+const getParser = file => {
   for (const [type, parser] of parserLookup) {
     if (minimatch(file, type, { nocase: true, dot: true, matchBase: true })) {
       return parser

package/lib/util/path.js

@@ -1,9 +1,9 @@
 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)}**`
+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,

package/lib/util/template.js

@@ -4,12 +4,12 @@ const { Range } = require('semver')
 const fs = require('fs')
 const DELETE = '__DELETE__'
 
-const safeValues = (obj) => Object.entries(obj).map(([key, value]) =>
-  [key, new Handlebars.SafeString(value)])
+const safeValues = obj => Object.entries(obj).map(([key, value]) => [key, new Handlebars.SafeString(value)])
 
-const partialName = (s) => basename(s, extname(s)) // remove extension
-  .replace(/^_/, '') // remove leading underscore
-  .replace(/-([a-z])/g, (_, g) => g.toUpperCase()) // camelcase
+const partialName = s =>
+  basename(s, extname(s)) // remove extension
+    .replace(/^_/, '') // remove leading underscore
+    .replace(/-([a-z])/g, (_, g) => g.toUpperCase()) // camelcase
 
 const makePartials = (dir, isBase) => {
   const partials = fs.readdirSync(dir).reduce((acc, f) => {
@@ -32,15 +32,16 @@ const makePartials = (dir, isBase) => {
   Handlebars.registerPartial(partials)
 }
 
-const setupHandlebars = (dirs) => {
+const setupHandlebars = dirs => {
   Handlebars.registerHelper('obj', ({ hash }) => Object.fromEntries(safeValues(hash)))
+  Handlebars.registerHelper('extGlob', arr => `{${arr.join(',')}}`)
   Handlebars.registerHelper('join', (arr, sep) => arr.join(typeof sep === 'string' ? sep : ', '))
   Handlebars.registerHelper('pluck', (arr, key) => arr.map(a => a[key]))
-  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('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))
-  Handlebars.registerHelper('semverRangeMajor', (v) => new Range(v).set[0][0].semver.major)
+  Handlebars.registerHelper('semverRangeMajor', v => new Range(v).set[0][0].semver.major)
   Handlebars.registerHelper('lte', (a, b) => a <= b)
 
   if (Array.isArray(dirs)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/template-oss",
-  "version": "4.22.0",
+  "version": "4.23.1",
   "description": "templated files used in npm CLI team oss projects",
   "main": "lib/content/index.js",
   "bin": {
@@ -10,17 +10,18 @@
     "template-oss-release-manager": "bin/release-manager.js"
   },
   "scripts": {
-    "lint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"",
-    "lintfix": "npm run lint -- --fix",
+    "lint": "npm run eslint && npm run prettier -- --check",
+    "lintfix": "npm run eslint -- --fix && npm run prettier -- --write",
     "posttest": "npm run lint",
     "snap": "tap",
     "test": "tap",
     "template-oss-apply": "template-oss-apply --force",
     "postlint": "template-oss-check",
     "postinstall": "template-oss-apply",
+    "eslint": "eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"",
+    "prettier": "prettier \"**/*.{js,cjs,ts,mjs,jsx,tsx,json}\"",
     "test-all": "npm run test -ws -iwr --if-present",
-    "lint-all": "npm run lint -ws -iwr --if-present",
-    "test:record": "TAP_SNAPSHOT=1 NOCK_RECORD=1 tap"
+    "lint-all": "npm run lint -ws -iwr --if-present"
   },
   "repository": {
     "type": "git",
@@ -56,7 +57,7 @@
     "minimatch": "^9.0.2",
     "npm-package-arg": "^11.0.1",
     "proc-log": "^4.0.0",
-    "release-please": "16.10.2",
+    "release-please": "16.12.0",
     "semver": "^7.3.5",
     "undici": "^6.7.0",
     "yaml": "^2.1.1"
@@ -66,9 +67,12 @@
     "lib/"
   ],
   "devDependencies": {
+    "@github/prettier-config": "0.0.6",
     "@npmcli/eslint-config": "^4.0.0",
     "@npmcli/template-oss": "file:./",
+    "eslint-config-prettier": "^9.1.0",
     "nock": "^13.3.8",
+    "prettier": "^3.2.5",
     "tap": "^16.0.0"
   },
   "tap": {
@@ -86,7 +90,8 @@
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
-    "publish": true
+    "publish": true,
+    "prettier": true
   },
   "engines": {
     "node": "^18.17.0 || >=20.5.0"