Skip to content

Commit 99de719

Browse files
everett1992everett1992
committed
feat: add lockfile resolved options
1 parent db5ca7b commit 99de719

File tree

5 files changed

+130
-0
lines changed

5 files changed

+130
-0
lines changed

‎docs/content/using-npm/config.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1161,6 +1161,22 @@ variable will be set to `'production'` for all lifecycle scripts.
11611161
<!-- automatically generated, do not edit manually -->
11621162
<!-- see lib/utils/config/definitions.js -->
11631163

1164+
#### `omit-lockfile-registry-resolved`
1165+
1166+
* Default: false
1167+
* Type: Boolean
1168+
1169+
Set to true to omit 'resolved' key from registry dependencies in lock files.
1170+
1171+
This setting is useful in projects that may install dependencies from
1172+
different registries but would use a lockfile to lock package versions. This
1173+
option makes installing slower because npm must fetch package manifest to
1174+
resolve the package version's tarball. See 'record-default-registry' for an
1175+
alternative.
1176+
1177+
<!-- automatically generated, do not edit manually -->
1178+
<!-- see lib/utils/config/definitions.js -->
1179+
11641180
#### `otp`
11651181

11661182
* Default: null
@@ -1333,6 +1349,22 @@ Rebuild bundled dependencies after installation.
13331349
<!-- automatically generated, do not edit manually -->
13341350
<!-- see lib/utils/config/definitions.js -->
13351351

1352+
#### `record-default-registry`
1353+
1354+
* Default: false
1355+
* Type: Boolean
1356+
1357+
Set to true to replace the actual registry in urls resolved from registires
1358+
with the default registry when recording lock files.
1359+
1360+
This setting is useful in projects that may install dependencies from
1361+
different registries but would use a lockfile to lock package versions. This
1362+
option supports registries that host tarballs at the same path. If even the
1363+
path may change see 'omit-lockfile-registry-resolved'.
1364+
1365+
<!-- automatically generated, do not edit manually -->
1366+
<!-- see lib/utils/config/definitions.js -->
1367+
13361368
#### `registry`
13371369

13381370
* Default: "https://registry.npmjs.org/"

‎lib/utils/config/definitions.js

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2304,3 +2304,33 @@ define('yes', {
23042304
the command line.
23052305
`,
23062306
})
2307+
2308+
define('omit-lockfile-registry-resolved', {
2309+
default: false,
2310+
type: Boolean,
2311+
description: `
2312+
Set to true to omit 'resolved' key from registry dependencies in lock files.
2313+
2314+
This setting is useful in projects that may install dependencies from
2315+
different registries but would use a lockfile to lock package versions.
2316+
This option makes installing slower because npm must fetch package manifest
2317+
to resolve the package version's tarball.
2318+
See 'record-default-registry' for an alternative.
2319+
`,
2320+
flatten,
2321+
})
2322+
2323+
define('record-default-registry', {
2324+
default: false,
2325+
type: Boolean,
2326+
description: `
2327+
Set to true to replace the actual registry in urls resolved from registires
2328+
with the default registry when recording lock files.
2329+
2330+
This setting is useful in projects that may install dependencies from
2331+
different registries but would use a lockfile to lock package versions.
2332+
This option supports registries that host tarballs at the same path. If
2333+
even the path may change see 'omit-lockfile-registry-resolved'.
2334+
`,
2335+
flatten,
2336+
})

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
158158
"workspaces": null,
159159
"workspaces-update": true,
160160
"yes": null,
161+
"omit-lockfile-registry-resolved": false,
162+
"record-default-registry": false,
161163
"metrics-registry": "https://registry.npmjs.org/"
162164
}
163165
`
@@ -255,6 +257,7 @@ noproxy = [""]
255257
npm-version = "{NPM-VERSION}"
256258
offline = false
257259
omit = []
260+
omit-lockfile-registry-resolved = false
258261
only = null
259262
optional = null
260263
otp = null
@@ -272,6 +275,7 @@ progress = true
272275
proxy = null
273276
read-only = false
274277
rebuild-bundle = true
278+
record-default-registry = false
275279
registry = "https://registry.npmjs.org/"
276280
save = true
277281
save-bundle = false

‎tap-snapshots/test/lib/utils/config/definitions.js.test.cjs

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@ Array [
154154
"workspaces",
155155
"workspaces-update",
156156
"yes",
157+
"omit-lockfile-registry-resolved",
158+
"record-default-registry",
157159
]
158160
`
159161

@@ -1223,6 +1225,21 @@ If the resulting omit list includes \`'dev'\`, then the \`NODE_ENV\` environment
12231225
variable will be set to \`'production'\` for all lifecycle scripts.
12241226
`
12251227

1228+
exports[`test/lib/utils/config/definitions.js TAP > config description for omit-lockfile-registry-resolved 1`] = `
1229+
#### \`omit-lockfile-registry-resolved\`
1230+
1231+
* Default: false
1232+
* Type: Boolean
1233+
1234+
Set to true to omit 'resolved' key from registry dependencies in lock files.
1235+
1236+
This setting is useful in projects that may install dependencies from
1237+
different registries but would use a lockfile to lock package versions. This
1238+
option makes installing slower because npm must fetch package manifest to
1239+
resolve the package version's tarball. See 'record-default-registry' for an
1240+
alternative.
1241+
`
1242+
12261243
exports[`test/lib/utils/config/definitions.js TAP > config description for only 1`] = `
12271244
#### \`only\`
12281245
@@ -1414,6 +1431,21 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for rebui
14141431
Rebuild bundled dependencies after installation.
14151432
`
14161433

1434+
exports[`test/lib/utils/config/definitions.js TAP > config description for record-default-registry 1`] = `
1435+
#### \`record-default-registry\`
1436+
1437+
* Default: false
1438+
* Type: Boolean
1439+
1440+
Set to true to replace the actual registry in urls resolved from registires
1441+
with the default registry when recording lock files.
1442+
1443+
This setting is useful in projects that may install dependencies from
1444+
different registries but would use a lockfile to lock package versions. This
1445+
option supports registries that host tarballs at the same path. If even the
1446+
path may change see 'omit-lockfile-registry-resolved'.
1447+
`
1448+
14171449
exports[`test/lib/utils/config/definitions.js TAP > config description for registry 1`] = `
14181450
#### \`registry\`
14191451

‎tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1035,6 +1035,22 @@ variable will be set to \`'production'\` for all lifecycle scripts.
10351035
<!-- automatically generated, do not edit manually -->
10361036
<!-- see lib/utils/config/definitions.js -->
10371037
1038+
#### \`omit-lockfile-registry-resolved\`
1039+
1040+
* Default: false
1041+
* Type: Boolean
1042+
1043+
Set to true to omit 'resolved' key from registry dependencies in lock files.
1044+
1045+
This setting is useful in projects that may install dependencies from
1046+
different registries but would use a lockfile to lock package versions. This
1047+
option makes installing slower because npm must fetch package manifest to
1048+
resolve the package version's tarball. See 'record-default-registry' for an
1049+
alternative.
1050+
1051+
<!-- automatically generated, do not edit manually -->
1052+
<!-- see lib/utils/config/definitions.js -->
1053+
10381054
#### \`otp\`
10391055
10401056
* Default: null
@@ -1207,6 +1223,22 @@ Rebuild bundled dependencies after installation.
12071223
<!-- automatically generated, do not edit manually -->
12081224
<!-- see lib/utils/config/definitions.js -->
12091225
1226+
#### \`record-default-registry\`
1227+
1228+
* Default: false
1229+
* Type: Boolean
1230+
1231+
Set to true to replace the actual registry in urls resolved from registires
1232+
with the default registry when recording lock files.
1233+
1234+
This setting is useful in projects that may install dependencies from
1235+
different registries but would use a lockfile to lock package versions. This
1236+
option supports registries that host tarballs at the same path. If even the
1237+
path may change see 'omit-lockfile-registry-resolved'.
1238+
1239+
<!-- automatically generated, do not edit manually -->
1240+
<!-- see lib/utils/config/definitions.js -->
1241+
12101242
#### \`registry\`
12111243
12121244
* Default: "https://registry.npmjs.org/"

0 commit comments

Comments
 (0)