@npmcli/config 10.0.0 → 10.1.0

package/lib/definitions/definitions.js

@@ -461,7 +461,7 @@ const definitions = {
   depth: new Definition('depth', {
     default: null,
     defaultDescription: `
-      \`Infinity\` if \`--all\` is set, otherwise \`1\`
+      \`Infinity\` if \`--all\` is set, otherwise \`0\`
     `,
     type: [null, Number],
     description: `
@@ -954,6 +954,14 @@ const definitions = {
       more information, or [npm init](/commands/npm-init).
     `,
   }),
+  'init-type': new Definition('init-type', {
+    default: 'commonjs',
+    type: String,
+    hint: '<type>',
+    description: `
+      The value that \`npm init\` should use by default for the package.json type field.
+    `,
+  }),
   'init-version': new Definition('init-version', {
     default: '1.0.0',
     type: Semver,
@@ -2231,7 +2239,6 @@ const definitions = {
   workspaces: new Definition('workspaces', {
     default: null,
     type: [null, Boolean],
-    short: 'ws',
     envExport: false,
     description: `
       Set to true to run the command in the context of **all** configured

package/lib/definitions/index.js

@@ -55,12 +55,26 @@ const shorthands = {
   readonly: ['--read-only'],
   reg: ['--registry'],
   iwr: ['--include-workspace-root'],
+  ws: ['--workspaces'],
   ...definitionProps.shorthands,
 }
 
+// These are the configs that we can nerf-dart. Only _auth even has a config definition so we have to explicitly validate them here.
+// This is used to validate during "npm config set" and to not warn on loading unknown configs when we see these.
+const nerfDarts = [
+  '_auth', // Has a config
+  '_authToken', // Does not have a config
+  '_password', // Does not have a config
+  'certfile', // Does not have a config
+  'email', // Does not have a config
+  'keyfile', // Does not have a config
+  'username', // Does not have a config
+]
+
 module.exports = {
   defaults: definitionProps.defaults,
   definitions,
   flatten,
+  nerfDarts,
   shorthands,
 }

package/lib/index.js

@@ -15,6 +15,14 @@ const {
   mkdir,
 } = require('node:fs/promises')
 
+// TODO these need to be either be ignored when parsing env, formalized as config, or not exported to the env in the first place. For now this list is just to suppress warnings till we can pay off this tech debt.
+const internalEnv = [
+  'global-prefix',
+  'local-prefix',
+  'npm-version',
+  'node-gyp',
+]
+
 const fileExists = (...p) => stat(resolve(...p))
   .then((st) => st.isFile())
   .catch(() => false)
@@ -61,6 +69,7 @@ class Config {
     definitions,
     shorthands,
     flatten,
+    nerfDarts = [],
     npmPath,
 
     // options just to override in tests, mostly
@@ -71,8 +80,9 @@ class Config {
     cwd = process.cwd(),
     excludeNpmCwd = false,
   }) {
-    // turn the definitions into nopt's weirdo syntax
+    this.nerfDarts = nerfDarts
     this.definitions = definitions
+    // turn the definitions into nopt's weirdo syntax
     const types = {}
     const defaults = {}
     this.deprecated = {}
@@ -272,6 +282,7 @@ class Config {
     }
 
     try {
+      // This does not have an actual definition
       defaultsObject['npm-version'] = require(join(this.npmPath, 'package.json')).version
     } catch {
       // in some weird state where the passed in npmPath does not have a package.json
@@ -346,6 +357,11 @@ class Config {
   }
 
   loadCLI () {
+    for (const s of Object.keys(this.shorthands)) {
+      if (s.length > 1 && this.argv.includes(`-${s}`)) {
+        log.warn(`-${s} is not a valid single-hyphen cli flag and will be removed in the future`)
+      }
+    }
     nopt.invalidHandler = (k, val, type) =>
       this.invalidHandler(k, val, type, 'command line options', 'cli')
     const conf = nopt(this.types, this.shorthands, this.argv)
@@ -566,13 +582,32 @@ class Config {
             }
           }
         }
+        // Some defaults like npm-version are not user-definable and thus don't have definitions
+        if (where !== 'default') {
+          this.checkUnknown(where, key)
+        }
         conf.data[k] = v
       }
     }
   }
 
+  checkUnknown (where, key) {
+    if (!this.definitions[key]) {
+      if (internalEnv.includes(key)) {
+        return
+      }
+      if (!key.includes(':')) {
+        log.warn(`Unknown ${where} config "${where === 'cli' ? '--' : ''}${key}". This will stop working in the next major version of npm.`)
+        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.`)
+      }
+    }
+  }
+
   #checkDeprecated (key) {
-    // XXX(npm9+) make this throw an error
     if (this.deprecated[key]) {
       log.warn('config', key, this.deprecated[key])
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/config",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "files": [
     "bin/",
     "lib/"
@@ -41,7 +41,7 @@
     "@npmcli/package-json": "^6.0.1",
     "ci-info": "^4.0.0",
     "ini": "^5.0.0",
-    "nopt": "^8.0.0",
+    "nopt": "^8.1.0",
     "proc-log": "^5.0.0",
     "semver": "^7.3.5",
     "walk-up-path": "^4.0.0"