Skip to content

Commit 5dd596e

Browse files
wraithgarwraithgar
committed
fix(config): remove node-version and npm-version
BREAKING CHANGE: the `node-version` and `npm-version` configs have been removed. These are only used sparingly by arborist to determine if optional dependencies should be installed, and during engines checks (which are only warnings unless `engine-strict` is true.
1 parent d01bb92 commit 5dd596e

File tree

6 files changed

+26
-54
lines changed

6 files changed

+26
-54
lines changed

‎lib/npm.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,12 @@ class Npm extends EventEmitter {
311311

312312
get flatOptions () {
313313
const { flat } = this.config
314-
// the Arborist constructor is used almost everywhere we call pacote, it's easiest
315-
// to attach it to flatOptions so it goes everywhere without having to touch every call
314+
// the Arborist constructor is used almost everywhere we call pacote, it's
315+
// easiest to attach it to flatOptions so it goes everywhere without having
316+
// to touch every call
316317
flat.Arborist = Arborist
318+
flat.nodeVersion = process.version
319+
flat.npmVersion = pkg.version
317320
if (this.command) {
318321
flat.npmCommand = this.command
319322
}

‎lib/utils/config/definitions.js

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,16 +1314,6 @@ define('node-options', {
13141314
`,
13151315
})
13161316

1317-
define('node-version', {
1318-
default: process.version,
1319-
defaultDescription: 'Node.js `process.version` value',
1320-
type: semver,
1321-
description: `
1322-
The node version to use when checking a package's \`engines\` setting.
1323-
`,
1324-
flatten,
1325-
})
1326-
13271317
define('noproxy', {
13281318
default: '',
13291319
defaultDescription: `
@@ -1344,16 +1334,6 @@ define('noproxy', {
13441334
},
13451335
})
13461336

1347-
define('npm-version', {
1348-
default: npmVersion,
1349-
defaultDescription: 'Output of `npm --version`',
1350-
type: semver,
1351-
description: `
1352-
The npm version to use when checking a package's \`engines\` setting.
1353-
`,
1354-
flatten,
1355-
})
1356-
13571337
define('offline', {
13581338
default: false,
13591339
type: Boolean,
@@ -2044,7 +2024,7 @@ define('tag-version-prefix', {
20442024
type: String,
20452025
description: `
20462026
If set, alters the prefix used when tagging a new version when performing
2047-
a version increment using \`npm-version\`. To remove the prefix
2027+
a version increment using \`npm version\`. To remove the prefix
20482028
altogether, set it to the empty string: \`""\`.
20492029
20502030
Because other tools may rely on the convention that npm version tags look
@@ -2166,8 +2146,8 @@ define('user-agent', {
21662146
inWorkspaces = true
21672147
}
21682148
flatOptions.userAgent =
2169-
value.replace(/\{node-version\}/gi, obj['node-version'])
2170-
.replace(/\{npm-version\}/gi, obj['npm-version'])
2149+
value.replace(/\{node-version\}/gi, process.version)
2150+
.replace(/\{npm-version\}/gi, npmVersion)
21712151
.replace(/\{platform\}/gi, process.platform)
21722152
.replace(/\{arch\}/gi, process.arch)
21732153
.replace(/\{workspaces\}/gi, inWorkspaces)

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

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,9 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
9696
"maxsockets": 15,
9797
"message": "%s",
9898
"node-options": null,
99-
"node-version": "{NODE-VERSION}",
10099
"noproxy": [
101100
""
102101
],
103-
"npm-version": "{NPM-VERSION}",
104102
"offline": false,
105103
"omit": [],
106104
"omit-lockfile-registry-resolved": false,
@@ -252,9 +250,7 @@ maxsockets = 15
252250
message = "%s"
253251
metrics-registry = "https://registry.npmjs.org/"
254252
node-options = null
255-
node-version = "{NODE-VERSION}"
256253
noproxy = [""]
257-
npm-version = "{NPM-VERSION}"
258254
offline = false
259255
omit = []
260256
omit-lockfile-registry-resolved = false
@@ -344,9 +340,9 @@ prefix = "{LOCALPREFIX}"
344340
userconfig = "{HOME}/.npmrc"
345341
346342
; node bin location = {EXECPATH}
347-
; node version = {NODE-VERSION}
343+
; node version = {PROCESS_VERSION}
348344
; npm local prefix = {LOCALPREFIX}
349-
; npm version = {NPM-VERSION}
345+
; npm version = {NPM_VERSION}
350346
; cwd = {NPMDIR}
351347
; HOME = {HOME}
352348
; Run \`npm config ls -l\` to show all defaults.
@@ -360,9 +356,9 @@ prefix = "{LOCALPREFIX}"
360356
userconfig = "{HOME}/.npmrc"
361357
362358
; node bin location = {EXECPATH}
363-
; node version = {NODE-VERSION}
359+
; node version = {PROCESS_VERSION}
364360
; npm local prefix = {LOCALPREFIX}
365-
; npm version = {NPM-VERSION}
361+
; npm version = {NPM_VERSION}
366362
; cwd = {NPMDIR}
367363
; HOME = {HOME}
368364
; Run \`npm config ls -l\` to show all defaults.
@@ -380,7 +376,7 @@ globalconfig = "{GLOBALPREFIX}/npmrc"
380376
init-module = "{HOME}/.npm-init.js"
381377
local-prefix = "{LOCALPREFIX}"
382378
; prefix = "{LOCALPREFIX}" ; overridden by cli
383-
user-agent = "npm/{NPM-VERSION} node/{NODE-VERSION} {PLATFORM} {ARCH} workspaces/false"
379+
user-agent = "npm/9.0.0-pre.4 node/v18.10.0 {PLATFORM} {ARCH} workspaces/false"
384380
; userconfig = "{HOME}/.npmrc" ; overridden by cli
385381
386382
; "cli" config from command line options
@@ -391,9 +387,9 @@ prefix = "{LOCALPREFIX}"
391387
userconfig = "{HOME}/.npmrc"
392388
393389
; node bin location = {EXECPATH}
394-
; node version = {NODE-VERSION}
390+
; node version = v18.10.0
395391
; npm local prefix = {LOCALPREFIX}
396-
; npm version = {NPM-VERSION}
392+
; npm version = 9.0.0-pre.4
397393
; cwd = {NPMDIR}
398394
; HOME = {HOME}
399395
; Run \`npm config ls -l\` to show all defaults.

‎test/fixtures/sandbox.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ class Sandbox extends EventEmitter {
155155
.split(normalize(homedir())).join('{REALHOME}')
156156
.split(this[_proxy].platform).join('{PLATFORM}')
157157
.split(this[_proxy].arch).join('{ARCH}')
158+
.replace(process.version, '{PROCESS_VERSION}')
159+
.replace(this[_npm].version, '{NPM_VERSION}')
158160

159161
// We do the defaults after everything else so that they don't cause the
160162
// other cleaners to miss values we would have clobbered here. For

‎test/lib/commands/config.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -330,21 +330,21 @@ t.test('config get no args', async t => {
330330
t.test('config get single key', async t => {
331331
const sandbox = new Sandbox(t)
332332

333-
await sandbox.run('config', ['get', 'node-version'])
334-
t.equal(sandbox.output, sandbox.config.get('node-version'), 'should get the value')
333+
await sandbox.run('config', ['get', 'all'])
334+
t.equal(sandbox.output, `${sandbox.config.get('all')}`, 'should get the value')
335335
})
336336

337337
t.test('config get multiple keys', async t => {
338338
const sandbox = new Sandbox(t)
339339

340-
await sandbox.run('config', ['get', 'node-version', 'npm-version'])
340+
await sandbox.run('config', ['get', 'yes', 'all'])
341341
t.ok(
342-
sandbox.output.includes(`node-version=${sandbox.config.get('node-version')}`),
343-
'outputs node-version'
342+
sandbox.output.includes(`yes=${sandbox.config.get('yes')}`),
343+
'outputs yes'
344344
)
345345
t.ok(
346-
sandbox.output.includes(`npm-version=${sandbox.config.get('npm-version')}`),
347-
'outputs npm-version'
346+
sandbox.output.includes(`all=${sandbox.config.get('all')}`),
347+
'outputs all'
348348
)
349349
})
350350

‎test/lib/utils/config/definitions.js

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
const t = require('tap')
22
const { resolve } = require('path')
33
const mockGlobals = require('../../../fixtures/mock-globals')
4+
const pkg = require('../../../../package.json')
45

56
// have to fake the node version, or else it'll only pass on this one
67
mockGlobals(t, { 'process.version': 'v14.8.0', 'process.env.NODE_ENV': undefined })
@@ -9,14 +10,6 @@ const mockDefs = (mocks = {}) => t.mock('../../../../lib/utils/config/definition
910

1011
const isWin = (isWindows) => ({ '../../../../lib/utils/is-windows.js': { isWindows } })
1112

12-
t.test('node and npm versions', t => {
13-
const definitions = mockDefs()
14-
const pkg = require('../../../../package.json')
15-
t.equal(definitions['npm-version'].default, pkg.version, 'npm-version default')
16-
t.equal(definitions['node-version'].default, process.version, 'node-version default')
17-
t.end()
18-
})
19-
2013
t.test('basic flattening function camelCases from css-case', t => {
2114
const flat = {}
2215
const obj = { 'prefer-online': true }
@@ -745,11 +738,9 @@ t.test('detect CI', t => {
745738
t.test('user-agent', t => {
746739
const obj = {
747740
'user-agent': mockDefs()['user-agent'].default,
748-
'npm-version': '1.2.3',
749-
'node-version': '9.8.7',
750741
}
751742
const flat = {}
752-
const expectNoCI = `npm/1.2.3 node/9.8.7 ` +
743+
const expectNoCI = `npm/${pkg.version} node/${process.version} ` +
753744
`${process.platform} ${process.arch} workspaces/false`
754745
mockDefs()['user-agent'].flatten('user-agent', obj, flat)
755746
t.equal(flat.userAgent, expectNoCI)

0 commit comments

Comments
 (0)