Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: accurately describe install-links effect on relative paths #5606

Merged
merged 1 commit into from Oct 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/content/commands/npm-audit.md
Expand Up @@ -456,9 +456,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-ci.md
Expand Up @@ -364,9 +364,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-dedupe.md
Expand Up @@ -311,9 +311,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-find-dupes.md
Expand Up @@ -235,9 +235,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-install-ci-test.md
Expand Up @@ -310,9 +310,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-install-test.md
Expand Up @@ -311,9 +311,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-install.md
Expand Up @@ -701,9 +701,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-link.md
Expand Up @@ -387,9 +387,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-ls.md
Expand Up @@ -290,9 +290,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-prune.md
Expand Up @@ -196,9 +196,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-rebuild.md
Expand Up @@ -166,9 +166,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-uninstall.md
Expand Up @@ -150,9 +150,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/commands/npm-update.md
Expand Up @@ -438,9 +438,9 @@ This value is not exported to the environment for child processes.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions docs/content/using-npm/config.md
Expand Up @@ -910,9 +910,9 @@ number, if not already set in package.json.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 3 additions & 3 deletions lib/utils/config/definitions.js
Expand Up @@ -1072,9 +1072,9 @@ define('install-links', {
default: true,
type: Boolean,
description: `
When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as
regular dependencies instead of creating a symlink. This option has
no effect on workspaces.
`,
flatten,
})
Expand Down
6 changes: 3 additions & 3 deletions tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
Expand Up @@ -981,9 +981,9 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for insta
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.
`

exports[`test/lib/utils/config/definitions.js TAP > config description for json 1`] = `
Expand Down
Expand Up @@ -783,9 +783,9 @@ number, if not already set in package.json.
* Default: true
* Type: Boolean

When set file: protocol dependencies that exist outside of the project root
will be packed and installed as regular dependencies instead of creating a
symlink. This option has no effect on workspaces.
When set file: protocol dependencies will be packed and installed as regular
dependencies instead of creating a symlink. This option has no effect on
workspaces.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down