@npmcli/template-oss 4.21.4 → 4.23.0

package/lib/util/files.js

@@ -12,48 +12,47 @@ 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 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
   // each other in the parser.
-  if (
-    stack[0] === ADD_KEY &&
-    FILE_KEYS.includes(stack[1]) &&
-    value?.file &&
-    srcValue?.overwrite === false
-  ) {
+  if (stack[0] === ADD_KEY && FILE_KEYS.includes(stack[1]) && value?.file && srcValue?.overwrite === false) {
     return [value, omit(srcValue, 'overwrite')]
   }
 }, customizers.overwriteArrays)
 
-const fileEntries = (dir, files, options, { allowMultipleSources = true } = {}) => {
+const fileEntries = (dir, files, options) => {
   const results = []
 
-  for (const [key, source] of Object.entries(files)) {
+  for (const [key, value] of Object.entries(files)) {
     // remove any false values first since that means those targets are skipped
-    if (source === false) {
+    if (value === false) {
       continue
     }
 
     // target paths need to be joined with dir and templated
     const target = join(dir, template(key, options))
 
-    if (Array.isArray(source)) {
-      // When turning an object of files into all its entries, we allow
-      // multiples when applying changes, but not when checking for changes
-      // since earlier files would always return as needing an update. So we
-      // either allow multiples and return the array or only return the last
-      // source file in the array.
-      const sources = allowMultipleSources ? source : source.slice(-1)
-      results.push(...sources.map(s => [target, s]))
-    } else {
-      results.push([target, source])
-    }
+    // Allow an array of values to merge into a single source to be
+    // applied or diffed against the target. This is how overwrite:false
+    // works and they are merged.
+    const source = Array.isArray(value)
+      ? value.reduce(
+          (acc, { file, ...rest }) => {
+            acc.file.push(file)
+            return Object.assign(acc, rest)
+          },
+          { file: [] },
+        )
+      : value
+
+    results.push([target, source])
   }
 
   return results
@@ -111,12 +110,12 @@ const parseEach = async (dir, files, options, parseOptions, fn) => {
 }
 
 const parseConfig = (files, dir, overrides, templateSettings) => {
-  const normalizeFiles = (v) => {
-    v = deepMapKeys(v, (s) => template(s, 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
+          // template files nows since they need to be normalized before merging
           acc[template(k, templateSettings)] = true
           return acc
         }, {})
@@ -133,15 +132,18 @@ const parseConfig = (files, dir, overrides, templateSettings) => {
   }
 
   const merged = mergeFiles(normalizeFiles(files), normalizeFiles(overrides))
-  const withDefaults = defaultsDeep(merged, FILE_KEYS.reduce((acc, k) => {
-    acc[k] = { [ADD_KEY]: {}, [RM_KEY]: {} }
-    return acc
-  }, {}))
+  const withDefaults = defaultsDeep(
+    merged,
+    FILE_KEYS.reduce((acc, k) => {
+      acc[k] = { [ADD_KEY]: {}, [RM_KEY]: {} }
+      return acc
+    }, {}),
+  )
 
   return withDefaults
 }
 
-const getAddedFiles = (files) => files ? Object.keys(files[ADD_KEY] || {}) : []
+const getAddedFiles = files => (files ? Object.keys(files[ADD_KEY] || {}) : [])
 
 module.exports = {
   rmEach,

package/lib/util/git.js

@@ -5,7 +5,7 @@ const { minimatch } = require('minimatch')
 const cache = new Map()
 
 const tryGit = async (path, ...args) => {
-  if (!await git.is({ cwd: path })) {
+  if (!(await git.is({ cwd: path }))) {
     throw new Error('no git')
   }
   const key = [path, ...args].join(',')
@@ -23,7 +23,7 @@ const getRemoteUrl = async (path, remote) => {
   try {
     const urlStr = await tryGit(path, 'remote', 'get-url', remote)
     const { domain, user, project } = hgi.fromUrl(urlStr)
-    const url = new URL(`https://${domain}`)
+    const url = new URL(`git+https://${domain}`)
     url.pathname = `/${user}/${project}.git`
     return url.toString()
   } catch {
@@ -31,7 +31,7 @@ const getRemoteUrl = async (path, remote) => {
   }
 }
 
-const getUrl = async (path) => {
+const getUrl = async path => {
   return (await getRemoteUrl(path, 'upstream')) ?? (await getRemoteUrl(path, 'origin'))
 }
 
@@ -41,7 +41,10 @@ const getBranches = async (path, branchPatterns) => {
 
   try {
     const res = await tryGit(path, 'ls-remote', '--heads', 'origin').then(r => r.split('\n'))
-    const remotes = res.map((h) => h.match(/refs\/heads\/(.*)$/)).filter(Boolean).map(h => h[1])
+    const remotes = res
+      .map(h => h.match(/refs\/heads\/(.*)$/))
+      .filter(Boolean)
+      .map(h => h[1])
     for (const branch of remotes) {
       for (const pattern of branchPatterns) {
         if (minimatch(branch, pattern)) {
@@ -61,7 +64,7 @@ const getBranches = async (path, branchPatterns) => {
   }
 }
 
-const defaultBranch = async (path) => {
+const defaultBranch = async path => {
   try {
     const remotes = await tryGit(path, 'remote', 'show', 'origin')
     return remotes.match(/HEAD branch: (.*)$/m)?.[1]

package/lib/util/gitignore.js

@@ -4,17 +4,19 @@ const localeCompare = require('@isaacs/string-locale-compare')('en')
 
 const sortGitPaths = (a, b) => localeCompare(a.replace(/^!/g, ''), b.replace(/^!/g, ''))
 
-const allowDir = (p) => {
+const allowDir = p => {
   const parts = p.split(posix.sep)
-  return parts.flatMap((part, index, list) => {
-    const prev = list.slice(0, index)
-    const isLast = index === list.length - 1
-    const ignorePart = ['', ...prev, part, ''].join(posix.sep)
-    return [`!${ignorePart}`, !isLast && `${ignorePart}*`]
-  }).filter(Boolean)
+  return parts
+    .flatMap((part, index, list) => {
+      const prev = list.slice(0, index)
+      const isLast = index === list.length - 1
+      const ignorePart = ['', ...prev, part, ''].join(posix.sep)
+      return [`!${ignorePart}`, !isLast && `${ignorePart}*`]
+    })
+    .filter(Boolean)
 }
 
-const allowRootDir = (p) => {
+const allowRootDir = p => {
   // This negates the first part of each path for the gitignore
   // files. It should be used to allow directories where everything
   // should be allowed inside such as .github/. It shouldn't be used on
@@ -26,9 +28,9 @@ const allowRootDir = (p) => {
 }
 
 const gitignore = {
-  allowDir: (dirs) => uniq(dirs.map(allowDir).flat()),
-  allowRootDir: (dirs) => dirs.map(allowRootDir).map((p) => `!${posix.sep}${p}`),
-  sort: (arr) => uniq(arr.sort(sortGitPaths)),
+  allowDir: dirs => uniq(dirs.map(allowDir).flat()),
+  allowRootDir: dirs => dirs.map(allowRootDir).map(p => `!${posix.sep}${p}`),
+  sort: arr => uniq(arr.sort(sortGitPaths)),
 }
 
 module.exports = gitignore

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))