Skip to content

Commit

Permalink
feat: default install-links to true (npm#5458)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: this changes the default value of `install-links` to
true

Closes npm/statusboard#510
  • Loading branch information
wraithgar authored Sep 8, 2022
1 parent 2e92800 commit 2a8c2fc
Show file tree
Hide file tree
Showing 21 changed files with 48 additions and 48 deletions.
2 changes: 1 addition & 1 deletion docs/content/commands/npm-audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-dedupe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-find-dupes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-install-ci-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-install-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-prune.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-rebuild.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/content/using-npm/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/utils/config/definitions.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion smoke-tests/tap-snapshots/test/index.js.test.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
4 changes: 2 additions & 2 deletions tap-snapshots/test/lib/commands/config.js.test.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down
28 changes: 14 additions & 14 deletions tap-snapshots/test/lib/load-all-commands.js.test.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -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
`
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
`
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
`
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 2a8c2fc

Please sign in to comment.