@npmcli/config 10.6.0 → 10.7.1

package/lib/definitions/definition.js

@@ -22,6 +22,8 @@ const allowed = [
   'typeDescription',
   'usage',
   'envExport',
+  'alias',
+  'required',
 ]
 
 const {

package/lib/definitions/definitions.js

@@ -246,6 +246,7 @@ const definitions = {
     default: null,
     hint: '<date>',
     type: [null, Date],
+    exclusive: ['min-release-age'],
     description: `
       If passed to \`npm install\`, will rebuild the npm tree such that only
       versions that were available **on or before** the given date are
@@ -1347,6 +1348,28 @@ const definitions = {
     `,
     flatten,
   }),
+  'min-release-age': new Definition('min-release-age', {
+    default: null,
+    hint: '<days>',
+    type: [null, Number],
+    exclusive: ['before'],
+    description: `
+       If set, npm will build the npm tree such that only versions that were
+       available more than the given number of days ago will be installed.  If
+       there are no versions available for the current set of dependencies, the
+       command will error.
+
+       This flag is a complement to \`before\`, which accepts an exact date
+       instead of a relative number of days.
+    `,
+    flatten: (key, obj, flatOptions) => {
+      if (obj['min-release-age'] !== null) {
+        flatOptions.before = new Date(Date.now() - (86400000 * obj['min-release-age']))
+        obj.before = flatOptions.before
+        delete obj['min-release-age']
+      }
+    },
+  }),
   'node-gyp': new Definition('node-gyp', {
     default: (() => {
       try {

package/lib/index.js

@@ -59,6 +59,7 @@ class Config {
   #flatten
   // populated the first time we flatten the object
   #flatOptions = null
+  #warnings = []
 
   static get typeDefs () {
     return typeDefs
@@ -78,20 +79,13 @@ class Config {
     execPath = process.execPath,
     cwd = process.cwd(),
     excludeNpmCwd = false,
+    warn = true,
   }) {
     this.nerfDarts = nerfDarts
     this.definitions = definitions
     // turn the definitions into nopt's weirdo syntax
-    const types = {}
-    const defaults = {}
-    this.deprecated = {}
-    for (const [key, def] of Object.entries(definitions)) {
-      defaults[key] = def.default
-      types[key] = def.type
-      if (def.deprecated) {
-        this.deprecated[key] = def.deprecated.trim().replace(/\n +/, '\n')
-      }
-    }
+    const { types, defaults, deprecated } = getTypesFromDefinitions(definitions)
+    this.deprecated = deprecated
 
     this.#flatten = flatten
     this.types = types
@@ -137,6 +131,7 @@ class Config {
     }
 
     this.#loaded = false
+    this.warn = warn
   }
 
   get list () {
@@ -369,7 +364,7 @@ class Config {
     }
     nopt.invalidHandler = (k, val, type) =>
       this.invalidHandler(k, val, type, 'command line options', 'cli')
-    nopt.unknownHandler = this.unknownHandler
+    nopt.unknownHandler = (k, next) => this.unknownHandler(k, next)
     nopt.abbrevHandler = this.abbrevHandler
     const conf = nopt(this.types, this.shorthands, this.argv)
     nopt.invalidHandler = null
@@ -545,7 +540,7 @@ class Config {
 
   unknownHandler (key, next) {
     if (next) {
-      log.warn(`"${next}" is being parsed as a normal command line argument.`)
+      this.queueWarning(`unknown:${next}`, `"${next}" is being parsed as a normal command line argument.`)
     }
   }
 
@@ -613,13 +608,16 @@ class Config {
       if (internalEnv.includes(key)) {
         return
       }
+      const hint = where !== 'cli'
+        ? ' See `npm help npmrc` for supported config options.'
+        : ''
       if (!key.includes(':')) {
-        log.warn(`Unknown ${where} config "${where === 'cli' ? '--' : ''}${key}". This will stop working in the next major version of npm.`)
+        this.queueWarning(key, `Unknown ${where} config "${where === 'cli' ? '--' : ''}${key}". This will stop working in the next major version of npm.${hint}`)
         return
       }
       const baseKey = key.split(':').pop()
       if (!this.definitions[baseKey] && !this.nerfDarts.includes(baseKey)) {
-        log.warn(`Unknown ${where} config "${baseKey}" (${key}). This will stop working in the next major version of npm.`)
+        this.queueWarning(baseKey, `Unknown ${where} config "${baseKey}" (${key}). This will stop working in the next major version of npm.${hint}`)
       }
     }
   }
@@ -923,6 +921,35 @@ class Config {
   setEnvs () {
     setEnvs(this)
   }
+
+  removeWarning (key) {
+    this.#warnings = this.#warnings.filter(w => w.type !== key)
+  }
+
+  getUnknownPositionals () {
+    return this.#warnings
+      .filter(w => w.type.startsWith('unknown:'))
+      .map(w => w.type.slice('unknown:'.length))
+  }
+
+  removeUnknownPositional (value) {
+    this.removeWarning(`unknown:${value}`)
+  }
+
+  queueWarning (type, ...args) {
+    if (!this.warn) {
+      this.#warnings.push({ type, args })
+    } else {
+      log.warn(...args)
+    }
+  }
+
+  logWarnings () {
+    for (const warning of this.#warnings) {
+      log.warn(...warning.args)
+    }
+    this.#warnings = []
+  }
 }
 
 const _loadError = Symbol('loadError')
@@ -980,4 +1007,21 @@ class ConfigData {
   }
 }
 
+const getTypesFromDefinitions = (definitions) => {
+  const types = {}
+  const defaults = {}
+  const deprecated = {}
+
+  for (const [key, def] of Object.entries(definitions)) {
+    defaults[key] = def.default
+    types[key] = def.type
+    if (def.deprecated) {
+      deprecated[key] = def.deprecated.trim().replace(/\n +/, '\n')
+    }
+  }
+
+  return { types, defaults, deprecated }
+}
+
 module.exports = Config
+module.exports.getTypesFromDefinitions = getTypesFromDefinitions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/config",
-  "version": "10.6.0",
+  "version": "10.7.1",
   "files": [
     "bin/",
     "lib/"
@@ -33,7 +33,7 @@
   "devDependencies": {
     "@npmcli/eslint-config": "^5.0.1",
     "@npmcli/mock-globals": "^1.0.0",
-    "@npmcli/template-oss": "4.25.1",
+    "@npmcli/template-oss": "4.29.0",
     "tap": "^16.3.8"
   },
   "dependencies": {
@@ -51,7 +51,7 @@
   },
   "templateOSS": {
     "//@npmcli/template-oss": "This file is partially managed by @npmcli/template-oss. Edits may be overwritten.",
-    "version": "4.25.1",
+    "version": "4.29.0",
     "content": "../../scripts/template-oss/index.js"
   }
 }