feat: default install-links to true (#5458)

wraithgar · web-flow · commit 2a8c2fcd124c · 2022-09-08T09:51:08.000-07:00
BREAKING CHANGE: this changes the default value of `install-links` to true Closes npm/statusboard#510
diff --git a/docs/content/commands/npm-audit.md b/docs/content/commands/npm-audit.md
@@ -453,7 +453,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-ci.md b/docs/content/commands/npm-ci.md
@@ -361,7 +361,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-dedupe.md b/docs/content/commands/npm-dedupe.md
@@ -308,7 +308,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-find-dupes.md b/docs/content/commands/npm-find-dupes.md
@@ -232,7 +232,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-install-ci-test.md b/docs/content/commands/npm-install-ci-test.md
@@ -307,7 +307,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-install-test.md b/docs/content/commands/npm-install-test.md
@@ -308,7 +308,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-install.md b/docs/content/commands/npm-install.md
@@ -698,7 +698,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-link.md b/docs/content/commands/npm-link.md
@@ -384,7 +384,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-ls.md b/docs/content/commands/npm-ls.md
@@ -287,7 +287,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-prune.md b/docs/content/commands/npm-prune.md
@@ -193,7 +193,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-rebuild.md b/docs/content/commands/npm-rebuild.md
@@ -163,7 +163,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-uninstall.md b/docs/content/commands/npm-uninstall.md
@@ -147,7 +147,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/commands/npm-update.md b/docs/content/commands/npm-update.md
@@ -435,7 +435,7 @@ This value is not exported to the environment for child processes.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
@@ -910,7 +910,7 @@ number, if not already set in package.json.
 
 #### `install-links`
 
-* Default: false
+* Default: true
 * Type: Boolean
 
 When set file: protocol dependencies that exist outside of the project root
diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -1083,7 +1083,7 @@ define('init.version', {
 })
 
 define('install-links', {
-  default: false,
+  default: true,
   type: Boolean,
   description: `
     When set file: protocol dependencies that exist outside of the project root
diff --git a/smoke-tests/tap-snapshots/test/index.js.test.cjs b/smoke-tests/tap-snapshots/test/index.js.test.cjs
@@ -61,7 +61,7 @@ npm ERR! [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
 npm ERR! [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
 npm ERR! [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 npm ERR! [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-npm ERR! [-ws|--workspaces] [--include-workspace-root] [--install-links]
+npm ERR! [-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 npm ERR! 
 npm ERR! aliases: clean-install, ic, install-clean, isntall-clean
 npm ERR! 
diff --git a/tap-snapshots/test/lib/commands/config.js.test.cjs b/tap-snapshots/test/lib/commands/config.js.test.cjs
@@ -81,7 +81,7 @@ exports[`test/lib/commands/config.js TAP config list --json > output matches sna
   "init.license": "ISC",
   "init.module": "{HOME}/.npm-init.js",
   "init.version": "1.0.0",
-  "install-links": false,
+  "install-links": true,
   "key": null,
   "legacy-bundling": false,
   "legacy-peer-deps": false,
@@ -237,7 +237,7 @@ init.author.url = ""
 init.license = "ISC" 
 init.module = "{HOME}/.npm-init.js" 
 init.version = "1.0.0" 
-install-links = false 
+install-links = true 
 json = false 
 key = null 
 legacy-bundling = false 
diff --git a/tap-snapshots/test/lib/load-all-commands.js.test.cjs b/tap-snapshots/test/lib/load-all-commands.js.test.cjs
@@ -52,7 +52,7 @@ Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]]
 [--foreground-scripts] [--ignore-scripts]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 Run "npm help audit" for more info
 `
@@ -110,7 +110,7 @@ Options:
 [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
 [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 aliases: clean-install, ic, install-clean, isntall-clean
 
@@ -156,7 +156,7 @@ Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
 [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 alias: ddp
 
@@ -305,7 +305,7 @@ Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
 [--no-audit] [--no-bin-links] [--no-fund]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 Run "npm help find-dupes" for more info
 `
@@ -404,7 +404,7 @@ Options:
 [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
 [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
 
@@ -424,7 +424,7 @@ Options:
 [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
 [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 alias: cit
 
@@ -444,7 +444,7 @@ Options:
 [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
 [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 alias: it
 
@@ -464,7 +464,7 @@ Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--ignore-scripts]
 [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 alias: ln
 
@@ -482,7 +482,7 @@ Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
 [--package-lock-only] [--unicode]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 alias: la
 
@@ -527,7 +527,7 @@ Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--link]
 [--package-lock-only] [--unicode]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 alias: list
 
@@ -662,7 +662,7 @@ Options:
 [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] [--dry-run]
 [--json] [--foreground-scripts] [--ignore-scripts]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 Run "npm help prune" for more info
 `
@@ -704,7 +704,7 @@ npm rebuild [<package-spec>] ...]
 Options:
 [-g|--global] [--no-bin-links] [--foreground-scripts] [--ignore-scripts]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 alias: rb
 
@@ -914,7 +914,7 @@ npm uninstall [<@scope>/]<pkg>...
 Options:
 [-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 aliases: unlink, remove, rm, r, un
 
@@ -960,7 +960,7 @@ Options:
 [--strict-peer-deps] [--no-package-lock] [--foreground-scripts]
 [--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run]
 [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
-[-ws|--workspaces] [--include-workspace-root] [--install-links]
+[-ws|--workspaces] [--include-workspace-root] [--no-install-links]
 
 aliases: up, upgrade, udpate
 
diff --git a/tap-snapshots/test/lib/npm.js.test.cjs b/tap-snapshots/test/lib/npm.js.test.cjs
diff --git a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
diff --git a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
