@npmcli/config 10.1.0 → 10.3.0

package/lib/definitions/definitions.js

@@ -847,7 +847,7 @@ const definitions = {
     type: Boolean,
     envExport: false,
     description: `
-      If true, npm will not exit with an error code when \`run-script\` is
+      If true, npm will not exit with an error code when \`run\` is
       invoked for a script that isn't defined in the \`scripts\` section of
       \`package.json\`. This option can be used when it's desirable to
       optionally run a script when it's present and fail if the script fails.
@@ -864,7 +864,7 @@ const definitions = {
 
       Note that commands explicitly intended to run a particular script, such
       as \`npm start\`, \`npm stop\`, \`npm restart\`, \`npm test\`, and \`npm
-      run-script\` will still run their intended script if \`ignore-scripts\` is
+      run\` will still run their intended script if \`ignore-scripts\` is
       set, but they will *not* run any pre- or post-scripts.
     `,
     flatten,
@@ -971,6 +971,14 @@ const definitions = {
       version number, if not already set in package.json.
     `,
   }),
+  'init-private': new Definition('init-private', {
+    default: false,
+    type: Boolean,
+    description: `
+      The value \`npm init\` should use by default for the package's private flag.
+    `,
+    flatten,
+  }),
   // these "aliases" are historically supported in .npmrc files, unfortunately
   // They should be removed in a future npm version.
   'init.author.email': new Definition('init.author.email', {
@@ -1294,6 +1302,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],
@@ -1682,6 +1703,7 @@ const definitions = {
     default: false,
     type: Boolean,
     short: 'D',
+    exclusive: ['save-optional', 'save-peer', 'save-prod'],
     description: `
       Save installed packages to a package.json file as \`devDependencies\`.
     `,
@@ -1713,6 +1735,7 @@ const definitions = {
     default: false,
     type: Boolean,
     short: 'O',
+    exclusive: ['save-dev', 'save-peer', 'save-prod'],
     description: `
       Save installed packages to a package.json file as
       \`optionalDependencies\`.
@@ -1741,6 +1764,7 @@ const definitions = {
   'save-peer': new Definition('save-peer', {
     default: false,
     type: Boolean,
+    exclusive: ['save-dev', 'save-optional', 'save-prod'],
     description: `
       Save installed packages to a package.json file as \`peerDependencies\`
     `,
@@ -1786,6 +1810,7 @@ const definitions = {
     default: false,
     type: Boolean,
     short: 'P',
+    exclusive: ['save-dev', 'save-optional', 'save-peer'],
     description: `
       Save installed packages into \`dependencies\` specifically. This is
       useful if a package already exists in \`devDependencies\` or

package/lib/index.js

@@ -15,12 +15,11 @@ 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.
+// 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',
-  'npm-version',
-  'node-gyp',
 ]
 
 const fileExists = (...p) => stat(resolve(...p))
@@ -282,7 +281,7 @@ class Config {
     }
 
     try {
-      // This does not have an actual definition
+      // 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
@@ -364,8 +363,11 @@ class Config {
     }
     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')
@@ -531,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)) {
@@ -582,8 +594,7 @@ class Config {
             }
           }
         }
-        // Some defaults like npm-version are not user-definable and thus don't have definitions
-        if (where !== 'default') {
+        if (where !== 'default' || key === 'npm-version') {
           this.checkUnknown(where, key)
         }
         conf.data[k] = v

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.1.0",
+  "version": "10.3.0",
   "files": [
     "bin/",
     "lib/"