Skip to content

Commit fe09ca5

Browse files
committed
docs: accurately describe install-links effect on relative paths
1 parent bc21552 commit fe09ca5

17 files changed

+51
-51
lines changed

docs/content/commands/npm-audit.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -456,9 +456,9 @@ This value is not exported to the environment for child processes.
456456
* Default: true
457457
* Type: Boolean
458458

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

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

docs/content/commands/npm-ci.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -364,9 +364,9 @@ This value is not exported to the environment for child processes.
364364
* Default: true
365365
* Type: Boolean
366366

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

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

docs/content/commands/npm-dedupe.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,9 @@ This value is not exported to the environment for child processes.
311311
* Default: true
312312
* Type: Boolean
313313
314-
When set file: protocol dependencies that exist outside of the project root
315-
will be packed and installed as regular dependencies instead of creating a
316-
symlink. This option has no effect on workspaces.
314+
When set file: protocol dependencies will be packed and installed as regular
315+
dependencies instead of creating a symlink. This option has no effect on
316+
workspaces.
317317
318318
<!-- automatically generated, do not edit manually -->
319319
<!-- see lib/utils/config/definitions.js -->

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -235,9 +235,9 @@ This value is not exported to the environment for child processes.
235235
* Default: true
236236
* Type: Boolean
237237

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

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

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,9 @@ This value is not exported to the environment for child processes.
310310
* Default: true
311311
* Type: Boolean
312312

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

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

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,9 @@ This value is not exported to the environment for child processes.
311311
* Default: true
312312
* Type: Boolean
313313

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

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

docs/content/commands/npm-install.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -701,9 +701,9 @@ This value is not exported to the environment for child processes.
701701
* Default: true
702702
* Type: Boolean
703703
704-
When set file: protocol dependencies that exist outside of the project root
705-
will be packed and installed as regular dependencies instead of creating a
706-
symlink. This option has no effect on workspaces.
704+
When set file: protocol dependencies will be packed and installed as regular
705+
dependencies instead of creating a symlink. This option has no effect on
706+
workspaces.
707707
708708
<!-- automatically generated, do not edit manually -->
709709
<!-- see lib/utils/config/definitions.js -->

docs/content/commands/npm-link.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -387,9 +387,9 @@ This value is not exported to the environment for child processes.
387387
* Default: true
388388
* Type: Boolean
389389

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

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

docs/content/commands/npm-ls.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -290,9 +290,9 @@ This value is not exported to the environment for child processes.
290290
* Default: true
291291
* Type: Boolean
292292

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

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

docs/content/commands/npm-prune.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,9 @@ This value is not exported to the environment for child processes.
196196
* Default: true
197197
* Type: Boolean
198198

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

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

docs/content/commands/npm-rebuild.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,9 @@ This value is not exported to the environment for child processes.
166166
* Default: true
167167
* Type: Boolean
168168

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

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

docs/content/commands/npm-uninstall.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,9 @@ This value is not exported to the environment for child processes.
150150
* Default: true
151151
* Type: Boolean
152152

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

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

docs/content/commands/npm-update.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -438,9 +438,9 @@ This value is not exported to the environment for child processes.
438438
* Default: true
439439
* Type: Boolean
440440

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

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

docs/content/using-npm/config.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -910,9 +910,9 @@ number, if not already set in package.json.
910910
* Default: true
911911
* Type: Boolean
912912

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

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

lib/utils/config/definitions.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1072,9 +1072,9 @@ define('install-links', {
10721072
default: true,
10731073
type: Boolean,
10741074
description: `
1075-
When set file: protocol dependencies that exist outside of the project root
1076-
will be packed and installed as regular dependencies instead of creating a
1077-
symlink. This option has no effect on workspaces.
1075+
When set file: protocol dependencies will be packed and installed as
1076+
regular dependencies instead of creating a symlink. This option has
1077+
no effect on workspaces.
10781078
`,
10791079
flatten,
10801080
})

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -981,9 +981,9 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for insta
981981
* Default: true
982982
* Type: Boolean
983983
984-
When set file: protocol dependencies that exist outside of the project root
985-
will be packed and installed as regular dependencies instead of creating a
986-
symlink. This option has no effect on workspaces.
984+
When set file: protocol dependencies will be packed and installed as regular
985+
dependencies instead of creating a symlink. This option has no effect on
986+
workspaces.
987987
`
988988

989989
exports[`test/lib/utils/config/definitions.js TAP > config description for json 1`] = `

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -783,9 +783,9 @@ number, if not already set in package.json.
783783
* Default: true
784784
* Type: Boolean
785785
786-
When set file: protocol dependencies that exist outside of the project root
787-
will be packed and installed as regular dependencies instead of creating a
788-
symlink. This option has no effect on workspaces.
786+
When set file: protocol dependencies will be packed and installed as regular
787+
dependencies instead of creating a symlink. This option has no effect on
788+
workspaces.
789789
790790
<!-- automatically generated, do not edit manually -->
791791
<!-- see lib/utils/config/definitions.js -->

0 commit comments

Comments
 (0)