Skip to content

Commit 2a8c2fc

Browse files
authored
feat: default install-links to true (npm#5458)
BREAKING CHANGE: this changes the default value of `install-links` to true Closes npm/statusboard#510
1 parent 2e92800 commit 2a8c2fc

21 files changed

+48
-48
lines changed

docs/content/commands/npm-audit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ This value is not exported to the environment for child processes.
453453

454454
#### `install-links`
455455

456-
* Default: false
456+
* Default: true
457457
* Type: Boolean
458458

459459
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-ci.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ This value is not exported to the environment for child processes.
361361

362362
#### `install-links`
363363

364-
* Default: false
364+
* Default: true
365365
* Type: Boolean
366366

367367
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-dedupe.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ This value is not exported to the environment for child processes.
308308
309309
#### `install-links`
310310
311-
* Default: false
311+
* Default: true
312312
* Type: Boolean
313313
314314
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-find-dupes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ This value is not exported to the environment for child processes.
232232

233233
#### `install-links`
234234

235-
* Default: false
235+
* Default: true
236236
* Type: Boolean
237237

238238
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-install-ci-test.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ This value is not exported to the environment for child processes.
307307

308308
#### `install-links`
309309

310-
* Default: false
310+
* Default: true
311311
* Type: Boolean
312312

313313
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-install-test.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ This value is not exported to the environment for child processes.
308308

309309
#### `install-links`
310310

311-
* Default: false
311+
* Default: true
312312
* Type: Boolean
313313

314314
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -698,7 +698,7 @@ This value is not exported to the environment for child processes.
698698
699699
#### `install-links`
700700
701-
* Default: false
701+
* Default: true
702702
* Type: Boolean
703703
704704
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-link.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ This value is not exported to the environment for child processes.
384384

385385
#### `install-links`
386386

387-
* Default: false
387+
* Default: true
388388
* Type: Boolean
389389

390390
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-ls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ This value is not exported to the environment for child processes.
287287

288288
#### `install-links`
289289

290-
* Default: false
290+
* Default: true
291291
* Type: Boolean
292292

293293
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-prune.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ This value is not exported to the environment for child processes.
193193

194194
#### `install-links`
195195

196-
* Default: false
196+
* Default: true
197197
* Type: Boolean
198198

199199
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-rebuild.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ This value is not exported to the environment for child processes.
163163

164164
#### `install-links`
165165

166-
* Default: false
166+
* Default: true
167167
* Type: Boolean
168168

169169
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-uninstall.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ This value is not exported to the environment for child processes.
147147

148148
#### `install-links`
149149

150-
* Default: false
150+
* Default: true
151151
* Type: Boolean
152152

153153
When set file: protocol dependencies that exist outside of the project root

docs/content/commands/npm-update.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ This value is not exported to the environment for child processes.
435435

436436
#### `install-links`
437437

438-
* Default: false
438+
* Default: true
439439
* Type: Boolean
440440

441441
When set file: protocol dependencies that exist outside of the project root

docs/content/using-npm/config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -910,7 +910,7 @@ number, if not already set in package.json.
910910

911911
#### `install-links`
912912

913-
* Default: false
913+
* Default: true
914914
* Type: Boolean
915915

916916
When set file: protocol dependencies that exist outside of the project root

lib/utils/config/definitions.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1083,7 +1083,7 @@ define('init.version', {
10831083
})
10841084

10851085
define('install-links', {
1086-
default: false,
1086+
default: true,
10871087
type: Boolean,
10881088
description: `
10891089
When set file: protocol dependencies that exist outside of the project root

smoke-tests/tap-snapshots/test/index.js.test.cjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ npm ERR! [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
6161
npm ERR! [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
6262
npm ERR! [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
6363
npm ERR! [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
64-
npm ERR! [-ws|--workspaces] [--include-workspace-root] [--install-links]
64+
npm ERR! [-ws|--workspaces] [--include-workspace-root] [--no-install-links]
6565
npm ERR!
6666
npm ERR! aliases: clean-install, ic, install-clean, isntall-clean
6767
npm ERR!

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
8181
"init.license": "ISC",
8282
"init.module": "{HOME}/.npm-init.js",
8383
"init.version": "1.0.0",
84-
"install-links": false,
84+
"install-links": true,
8585
"key": null,
8686
"legacy-bundling": false,
8787
"legacy-peer-deps": false,
@@ -237,7 +237,7 @@ init.author.url = ""
237237
init.license = "ISC"
238238
init.module = "{HOME}/.npm-init.js"
239239
init.version = "1.0.0"
240-
install-links = false
240+
install-links = true
241241
json = false
242242
key = null
243243
legacy-bundling = false

tap-snapshots/test/lib/load-all-commands.js.test.cjs

+14-14
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Options:
5252
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
5353
[--foreground-scripts] [--ignore-scripts]
5454
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
55-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
55+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
5656
5757
Run "npm help audit" for more info
5858
`
@@ -110,7 +110,7 @@ Options:
110110
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
111111
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
112112
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
113-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
113+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
114114
115115
aliases: clean-install, ic, install-clean, isntall-clean
116116
@@ -156,7 +156,7 @@ Options:
156156
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
157157
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
158158
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
159-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
159+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
160160
161161
alias: ddp
162162
@@ -305,7 +305,7 @@ Options:
305305
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
306306
[--no-audit] [--no-bin-links] [--no-fund]
307307
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
308-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
308+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
309309
310310
Run "npm help find-dupes" for more info
311311
`
@@ -404,7 +404,7 @@ Options:
404404
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
405405
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
406406
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
407-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
407+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
408408
409409
aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
410410
@@ -424,7 +424,7 @@ Options:
424424
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
425425
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
426426
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
427-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
427+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
428428
429429
alias: cit
430430
@@ -444,7 +444,7 @@ Options:
444444
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
445445
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
446446
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
447-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
447+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
448448
449449
alias: it
450450
@@ -464,7 +464,7 @@ Options:
464464
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
465465
[--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
466466
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
467-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
467+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
468468
469469
alias: ln
470470
@@ -482,7 +482,7 @@ Options:
482482
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
483483
[--package-lock-only] [--unicode]
484484
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
485-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
485+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
486486
487487
alias: la
488488
@@ -527,7 +527,7 @@ Options:
527527
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
528528
[--package-lock-only] [--unicode]
529529
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
530-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
530+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
531531
532532
alias: list
533533
@@ -662,7 +662,7 @@ Options:
662662
[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--dry-run]
663663
[--json] [--foreground-scripts] [--ignore-scripts]
664664
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
665-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
665+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
666666
667667
Run "npm help prune" for more info
668668
`
@@ -704,7 +704,7 @@ npm rebuild [<package-spec>] ...]
704704
Options:
705705
[-g|--global] [--no-bin-links] [--foreground-scripts] [--ignore-scripts]
706706
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
707-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
707+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
708708
709709
alias: rb
710710
@@ -914,7 +914,7 @@ npm uninstall [<@scope>/]<pkg>...
914914
Options:
915915
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
916916
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
917-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
917+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
918918
919919
aliases: unlink, remove, rm, r, un
920920
@@ -960,7 +960,7 @@ Options:
960960
[--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
961961
[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
962962
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
963-
[-ws|--workspaces] [--include-workspace-root] [--install-links]
963+
[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
964964
965965
aliases: up, upgrade, udpate
966966

0 commit comments

Comments
 (0)