feat: add node-gyp as actual config

This formalizes the `node-gyp` config that is eventually consumed by [@npmcli/run-script](npm.im/@npmcli/run-script).

That module will need to be updated so that it can accept this config and use it if found, only falling back to its current behavior by default.

Author: wraithgar

lib/commands/run-script.js

@@ -129,14 +129,14 @@ class RunScript extends BaseCommand {
 
     for (const [ev, evArgs] of events) {
       await runScript({
+        args: evArgs,
+        event: ev,
+        nodeGyp: this.npm.config.get('node-gyp'),
         path,
-        // this || undefined is because runScript will be unhappy with the
-        // default null value
+        pkg,
+        // || undefined is because runScript will be unhappy with the default null value
         scriptShell: this.npm.config.get('script-shell') || undefined,
         stdio: 'inherit',
-        pkg,
-        event: ev,
-        args: evArgs,
       })
     }
   }

tap-snapshots/test/lib/commands/config.js.test.cjs

@@ -98,6 +98,7 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
   "long": false,
   "maxsockets": 15,
   "message": "%s",
+  "node-gyp": "{CWD}/node_modules/node-gyp/bin/node-gyp.js",
   "node-options": null,
   "noproxy": [
     ""
@@ -263,6 +264,7 @@ logs-max = 10
 ; long = false ; overridden by cli
 maxsockets = 15
 message = "%s"
+node-gyp = "{CWD}/node_modules/node-gyp/bin/node-gyp.js"
 node-options = null
 noproxy = [""]
 npm-version = "{NPM-VERSION}"

tap-snapshots/test/lib/docs.js.test.cjs

@@ -1072,6 +1072,19 @@ Any "%s" in the message will be replaced with the version number.
 
 
 
+#### \`node-gyp\`
+
+* Default: The path to the node-gyp bin that ships with npm
+* Type: Path
+
+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.
+
+
+
 #### \`node-options\`
 
 * Default: null
@@ -2158,6 +2171,7 @@ Array [
   "long",
   "maxsockets",
   "message",
+  "node-gyp",
   "node-options",
   "noproxy",
   "offline",
@@ -2300,6 +2314,7 @@ Array [
   "loglevel",
   "maxsockets",
   "message",
+  "node-gyp",
   "noproxy",
   "offline",
   "omit",
@@ -2454,6 +2469,7 @@ Object {
   "maxSockets": 15,
   "message": "%s",
   "nodeBin": "{NODE}",
+  "nodeGyp": "{CWD}/node_modules/node-gyp/bin/node-gyp.js",
   "nodeVersion": "2.2.2",
   "noProxy": "",
   "npmBin": "{CWD}/other/bin/npm-cli.js",

test/lib/commands/run-script.js

@@ -347,6 +347,7 @@ t.test('skip pre/post hooks when using ignoreScripts', async t => {
           env: 'env',
         },
       },
+      nodeGyp: npm.config.get('node-gyp'),
       event: 'env',
     },
   ])
@@ -485,6 +486,25 @@ t.test('list scripts, only non-commands', async t => {
   t.matchSnapshot(joinedOutput())
 })
 
+t.test('node-gyp config', async t => {
+  const { runScript, RUN_SCRIPTS, npm } = await mockRs(t, {
+    prefixDir: {
+      'package.json': JSON.stringify({
+        name: 'x',
+        version: '1.2.3',
+      }),
+    },
+    config: { 'node-gyp': '/test/node-gyp.js' },
+  })
+
+  await runScript.exec(['env'])
+  t.match(RUN_SCRIPTS(), [
+    {
+      nodeGyp: npm.config.get('node-gyp'),
+    },
+  ])
+})
+
 t.test('workspaces', async t => {
   const mockWorkspaces = async (t, {
     runScript,

workspaces/config/lib/definitions/definitions.js

@@ -1294,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],

workspaces/config/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

workspaces/config/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
 }

workspaces/config/tap-snapshots/test/type-description.js.test.cjs

@@ -325,6 +325,9 @@ Object {
   "message": Array [
     Function String(),
   ],
+  "node-gyp": Array [
+    "valid filesystem path",
+  ],
   "node-options": Array [
     null,
     Function String(),

workspaces/config/test/set-envs.js

@@ -11,6 +11,7 @@ const NODE = execPath
 
 const npmPath = '{path}'
 const npmBin = join(npmPath, 'bin/npm-cli.js')
+const nodeGypPath = require.resolve('node-gyp/bin/node-gyp.js')
 
 const mockDefinitions = (t) => {
   mockGlobals(t, { 'process.env': { EDITOR: 'vim' } })
@@ -27,6 +28,8 @@ t.test('set envs that are not defaults and not already in env', t => {
     INIT_CWD: cwd,
     EDITOR: 'vim',
     HOME: undefined,
+    npm_config_node_gyp: nodeGypPath,
+    npm_config_npm_version: 'unknown',
     npm_execpath: npmBin,
     npm_node_execpath: execPath,
     npm_config_global_prefix: globalPrefix,
@@ -80,6 +83,8 @@ t.test('set envs that are not defaults and not already in env, array style', t =
     INIT_CWD: cwd,
     EDITOR: 'vim',
     HOME: undefined,
+    npm_config_node_gyp: nodeGypPath,
+    npm_config_npm_version: 'unknown',
     npm_execpath: npmBin,
     npm_node_execpath: execPath,
     npm_config_global_prefix: globalPrefix,
@@ -130,6 +135,8 @@ t.test('set envs that are not defaults and not already in env, boolean edition',
     INIT_CWD: cwd,
     EDITOR: 'vim',
     HOME: undefined,
+    npm_config_node_gyp: nodeGypPath,
+    npm_config_npm_version: 'unknown',
     npm_execpath: npmBin,
     npm_node_execpath: execPath,
     npm_config_global_prefix: globalPrefix,
@@ -207,6 +214,8 @@ t.test('dont set configs marked as envExport:false', t => {
     INIT_CWD: cwd,
     EDITOR: 'vim',
     HOME: undefined,
+    npm_config_node_gyp: nodeGypPath,
+    npm_config_npm_version: 'unknown',
     npm_execpath: npmBin,
     npm_node_execpath: execPath,
     npm_config_global_prefix: globalPrefix,