@npmcli/config 10.0.1 → 10.2.0

package/lib/definitions/definitions.js

@@ -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,
@@ -1286,6 +1294,19 @@ const definitions = {
     `,
     flatten,
   }),
+  'node-gyp': new Definition('node-gyp', {
+    default: require.resolve('node-gyp/bin/node-gyp.js'),
+    defaultDescription: `
+      The path to the node-gyp bin that ships with npm
+    `,
+    type: path,
+    description: `
+      This is the location of the "node-gyp" bin.  By default it uses one that ships with npm itself.
+
+      You can use this config to specify your own "node-gyp" to run when it is required to build a package.
+    `,
+    flatten,
+  }),
   'node-options': new Definition('node-options', {
     default: null,
     type: [null, String],
@@ -2231,7 +2252,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,13 @@ const {
   mkdir,
 } = require('node:fs/promises')
 
+// TODO global-prefix and local-prefix are set by lib/set-envs.js.  This may not be the best way to persist those, if we even want to persist them (see set-envs.js)
+const internalEnv = [
+  'npm-version',
+  'global-prefix',
+  'local-prefix',
+]
+
 const fileExists = (...p) => stat(resolve(...p))
   .then((st) => st.isFile())
   .catch(() => false)
@@ -61,6 +68,7 @@ class Config {
     definitions,
     shorthands,
     flatten,
+    nerfDarts = [],
     npmPath,
 
     // options just to override in tests, mostly
@@ -71,8 +79,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 +281,7 @@ class Config {
     }
 
     try {
+      // This does not have an actual definition because this is not user defineable
       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,10 +356,18 @@ 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')
+    nopt.unknownHandler = this.unknownHandler
+    nopt.abbrevHandler = this.abbrevHandler
     const conf = nopt(this.types, this.shorthands, this.argv)
     nopt.invalidHandler = null
+    nopt.unknownHandler = null
     this.parsedArgv = conf.argv
     delete conf.argv
     this.#loadObject(conf, 'cli', 'command line options')
@@ -515,6 +533,16 @@ class Config {
     log.warn('invalid config', msg, desc)
   }
 
+  abbrevHandler (short, long) {
+    log.warn(`Expanding --${short} to --${long}. This will stop working in the next major version of npm.`)
+  }
+
+  unknownHandler (key, next) {
+    if (next) {
+      log.warn(`"${next}" is being parsed as a normal command line argument.`)
+    }
+  }
+
   #getOneOfKeywords (mustBe, typeDesc) {
     let keyword
     if (mustBe.length === 1 && typeDesc.includes(Array)) {
@@ -566,13 +594,31 @@ class Config {
             }
           }
         }
+        if (where !== 'default' || key === 'npm-version') {
+          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/lib/set-envs.js

@@ -90,6 +90,7 @@ const setEnvs = (config) => {
 
   // also set some other common nice envs that we want to rely on
   env.HOME = config.home
+  // TODO this may not be the best away to persist these
   env.npm_config_global_prefix = config.globalPrefix
   env.npm_config_local_prefix = config.localPrefix
   if (cliConf.editor) {
@@ -101,6 +102,10 @@ const setEnvs = (config) => {
   if (cliConf['node-options']) {
     env.NODE_OPTIONS = cliConf['node-options']
   }
+  // the node-gyp bin uses this so we always set it
+  env.npm_config_node_gyp = cliConf['node-gyp']
+  // this doesn't have a full definition so we manually export it here
+  env.npm_config_npm_version = cliConf['npm-version'] || 'unknown'
   env.npm_execpath = config.npmBin
   env.NODE = env.npm_node_execpath = config.execPath
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@npmcli/config",
-  "version": "10.0.1",
+  "version": "10.2.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"