Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLuke Karrys <luke@lukekarrys.com>2021-09-30 23:55:55 +0300
committerLuke Karrys <luke@lukekarrys.com>2021-09-30 23:55:55 +0300
commitd7d5dd6aa66251805afd9009e3978f61ea732f05 (patch)
treea9f30844846e3dc4748bc5e222a7fa4a4ad2220b /docs
parentf17dfa0ced7d8df9bb7baf378bb20d33175c8e8b (diff)
Revert "feat(workspaces): --include-workspace-root"
This reverts commit f17dfa0ced7d8df9bb7baf378bb20d33175c8e8b.
Diffstat (limited to 'docs')
-rw-r--r--docs/content/commands/npm-audit.md32
-rw-r--r--docs/content/commands/npm-dedupe.md32
-rw-r--r--docs/content/commands/npm-diff.md32
-rw-r--r--docs/content/commands/npm-dist-tag.md32
-rw-r--r--docs/content/commands/npm-docs.md32
-rw-r--r--docs/content/commands/npm-exec.md32
-rw-r--r--docs/content/commands/npm-explain.md4
-rw-r--r--docs/content/commands/npm-find-dupes.md32
-rw-r--r--docs/content/commands/npm-fund.md4
-rw-r--r--docs/content/commands/npm-init.md18
-rw-r--r--docs/content/commands/npm-install-test.md32
-rw-r--r--docs/content/commands/npm-install.md32
-rw-r--r--docs/content/commands/npm-link.md32
-rw-r--r--docs/content/commands/npm-ls.md32
-rw-r--r--docs/content/commands/npm-outdated.md4
-rw-r--r--docs/content/commands/npm-pack.md32
-rw-r--r--docs/content/commands/npm-pkg.md18
-rw-r--r--docs/content/commands/npm-prune.md32
-rw-r--r--docs/content/commands/npm-publish.md32
-rw-r--r--docs/content/commands/npm-rebuild.md32
-rw-r--r--docs/content/commands/npm-repo.md32
-rw-r--r--docs/content/commands/npm-run-script.md32
-rw-r--r--docs/content/commands/npm-set-script.md32
-rw-r--r--docs/content/commands/npm-uninstall.md32
-rw-r--r--docs/content/commands/npm-unpublish.md18
-rw-r--r--docs/content/commands/npm-update.md32
-rw-r--r--docs/content/commands/npm-version.md32
-rw-r--r--docs/content/commands/npm-view.md32
-rw-r--r--docs/content/using-npm/config.md32
29 files changed, 136 insertions, 666 deletions
diff --git a/docs/content/commands/npm-audit.md b/docs/content/commands/npm-audit.md
index 58c614d79..9fa8c0fcc 100644
--- a/docs/content/commands/npm-audit.md
+++ b/docs/content/commands/npm-audit.md
@@ -313,8 +313,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -327,35 +327,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-dedupe.md b/docs/content/commands/npm-dedupe.md
index 377e17d81..dcb2a98fe 100644
--- a/docs/content/commands/npm-dedupe.md
+++ b/docs/content/commands/npm-dedupe.md
@@ -247,8 +247,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -261,35 +261,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-diff.md b/docs/content/commands/npm-diff.md
index 8d05df779..cf0bbec15 100644
--- a/docs/content/commands/npm-diff.md
+++ b/docs/content/commands/npm-diff.md
@@ -286,8 +286,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -300,35 +300,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-dist-tag.md b/docs/content/commands/npm-dist-tag.md
index a4e0243aa..4ad68ff56 100644
--- a/docs/content/commands/npm-dist-tag.md
+++ b/docs/content/commands/npm-dist-tag.md
@@ -106,8 +106,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -120,35 +120,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-docs.md b/docs/content/commands/npm-docs.md
index 970d17aa8..9f1387dae 100644
--- a/docs/content/commands/npm-docs.md
+++ b/docs/content/commands/npm-docs.md
@@ -63,8 +63,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -77,35 +77,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-exec.md b/docs/content/commands/npm-exec.md
index db2353662..82908d65e 100644
--- a/docs/content/commands/npm-exec.md
+++ b/docs/content/commands/npm-exec.md
@@ -164,8 +164,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -178,35 +178,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-explain.md b/docs/content/commands/npm-explain.md
index 5f05cac0f..4a8af2f70 100644
--- a/docs/content/commands/npm-explain.md
+++ b/docs/content/commands/npm-explain.md
@@ -85,8 +85,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
diff --git a/docs/content/commands/npm-find-dupes.md b/docs/content/commands/npm-find-dupes.md
index f7dc84f9c..e9dbac6d1 100644
--- a/docs/content/commands/npm-find-dupes.md
+++ b/docs/content/commands/npm-find-dupes.md
@@ -174,8 +174,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -188,35 +188,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-fund.md b/docs/content/commands/npm-fund.md
index 606b0a188..83c0b13d8 100644
--- a/docs/content/commands/npm-fund.md
+++ b/docs/content/commands/npm-fund.md
@@ -122,8 +122,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
diff --git a/docs/content/commands/npm-init.md b/docs/content/commands/npm-init.md
index d5a02494f..7355c7588 100644
--- a/docs/content/commands/npm-init.md
+++ b/docs/content/commands/npm-init.md
@@ -200,8 +200,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -214,20 +214,12 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
+* Default: false
+* Type: Boolean
-Set to true to run the command in the context of **all** configured
+Enable running a command in the context of **all** the configured
workspaces.
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
diff --git a/docs/content/commands/npm-install-test.md b/docs/content/commands/npm-install-test.md
index c464e5bd0..c2f9ab3d2 100644
--- a/docs/content/commands/npm-install-test.md
+++ b/docs/content/commands/npm-install-test.md
@@ -241,8 +241,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -255,35 +255,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-install.md b/docs/content/commands/npm-install.md
index a103845d1..de7378718 100644
--- a/docs/content/commands/npm-install.md
+++ b/docs/content/commands/npm-install.md
@@ -625,8 +625,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -639,35 +639,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-link.md b/docs/content/commands/npm-link.md
index d4ef41ae9..5811a8b23 100644
--- a/docs/content/commands/npm-link.md
+++ b/docs/content/commands/npm-link.md
@@ -325,8 +325,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -339,35 +339,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-ls.md b/docs/content/commands/npm-ls.md
index 3b33f0a36..528140bee 100644
--- a/docs/content/commands/npm-ls.md
+++ b/docs/content/commands/npm-ls.md
@@ -227,8 +227,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -241,35 +241,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-outdated.md b/docs/content/commands/npm-outdated.md
index 1b58a6afd..8eb5528c3 100644
--- a/docs/content/commands/npm-outdated.md
+++ b/docs/content/commands/npm-outdated.md
@@ -167,8 +167,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
diff --git a/docs/content/commands/npm-pack.md b/docs/content/commands/npm-pack.md
index 539459868..dda30512d 100644
--- a/docs/content/commands/npm-pack.md
+++ b/docs/content/commands/npm-pack.md
@@ -69,8 +69,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -83,35 +83,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-pkg.md b/docs/content/commands/npm-pkg.md
index beee9c1c4..bf6a2df5d 100644
--- a/docs/content/commands/npm-pkg.md
+++ b/docs/content/commands/npm-pkg.md
@@ -223,8 +223,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -237,20 +237,12 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
+* Default: false
+* Type: Boolean
-Set to true to run the command in the context of **all** configured
+Enable running a command in the context of **all** the configured
workspaces.
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
diff --git a/docs/content/commands/npm-prune.md b/docs/content/commands/npm-prune.md
index 658ab2610..7bd7ad131 100644
--- a/docs/content/commands/npm-prune.md
+++ b/docs/content/commands/npm-prune.md
@@ -103,8 +103,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -117,35 +117,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-publish.md b/docs/content/commands/npm-publish.md
index 6958b1066..946109de4 100644
--- a/docs/content/commands/npm-publish.md
+++ b/docs/content/commands/npm-publish.md
@@ -188,8 +188,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -202,35 +202,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-rebuild.md b/docs/content/commands/npm-rebuild.md
index 75e71c60e..19684796f 100644
--- a/docs/content/commands/npm-rebuild.md
+++ b/docs/content/commands/npm-rebuild.md
@@ -89,8 +89,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -103,35 +103,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-repo.md b/docs/content/commands/npm-repo.md
index cd47fde47..c3c509e0b 100644
--- a/docs/content/commands/npm-repo.md
+++ b/docs/content/commands/npm-repo.md
@@ -50,8 +50,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -64,35 +64,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-run-script.md b/docs/content/commands/npm-run-script.md
index 6dd602d03..e436bc27f 100644
--- a/docs/content/commands/npm-run-script.md
+++ b/docs/content/commands/npm-run-script.md
@@ -152,8 +152,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -166,35 +166,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-set-script.md b/docs/content/commands/npm-set-script.md
index 869ceede0..e39b7a18c 100644
--- a/docs/content/commands/npm-set-script.md
+++ b/docs/content/commands/npm-set-script.md
@@ -44,8 +44,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -58,35 +58,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-uninstall.md b/docs/content/commands/npm-uninstall.md
index 824d0d876..c04e1a7fd 100644
--- a/docs/content/commands/npm-uninstall.md
+++ b/docs/content/commands/npm-uninstall.md
@@ -85,8 +85,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -99,35 +99,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-unpublish.md b/docs/content/commands/npm-unpublish.md
index 13589a03e..1678bb305 100644
--- a/docs/content/commands/npm-unpublish.md
+++ b/docs/content/commands/npm-unpublish.md
@@ -107,8 +107,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -121,20 +121,12 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
+* Default: false
+* Type: Boolean
-Set to true to run the command in the context of **all** configured
+Enable running a command in the context of **all** the configured
workspaces.
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
diff --git a/docs/content/commands/npm-update.md b/docs/content/commands/npm-update.md
index ad02118e4..57b9b91f9 100644
--- a/docs/content/commands/npm-update.md
+++ b/docs/content/commands/npm-update.md
@@ -341,8 +341,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -355,35 +355,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-version.md b/docs/content/commands/npm-version.md
index 91ab0dee0..a02bf5bb9 100644
--- a/docs/content/commands/npm-version.md
+++ b/docs/content/commands/npm-version.md
@@ -103,8 +103,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -117,35 +117,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/commands/npm-view.md b/docs/content/commands/npm-view.md
index 9a1793f13..af354deb8 100644
--- a/docs/content/commands/npm-view.md
+++ b/docs/content/commands/npm-view.md
@@ -127,8 +127,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -141,35 +141,13 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
-
-Set to true to run the command in the context of **all** configured
-workspaces.
-
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
-This value is not exported to the environment for child processes.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
-#### `include-workspace-root`
-
* Default: false
* Type: Boolean
-Include the workspace root when workspaces are enabled for a command.
+Enable running a command in the context of **all** the configured
+workspaces.
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
+This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
index 647a9e1e0..10e8ca9b9 100644
--- a/docs/content/using-npm/config.md
+++ b/docs/content/using-npm/config.md
@@ -806,20 +806,6 @@ This is experimental, and not implemented by the npm public registry.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
-#### `include-workspace-root`
-
-* Default: false
-* Type: Boolean
-
-Include the workspace root when workspaces are enabled for a command.
-
-When false, specifying individual workspaces via the `workspace` config, or
-all workspaces via the `workspaces` flag, will cause npm to operate only on
-the specified workspaces, and not on the root project.
-
-<!-- automatically generated, do not edit manually -->
-<!-- see lib/utils/config/definitions.js -->
-
#### `init-author-email`
* Default: ""
@@ -1758,8 +1744,8 @@ Valid values for the `workspace` config are either:
* Workspace names
* Path to a workspace directory
-* Path to a parent workspace directory (will result in selecting all
- workspaces within that folder)
+* Path to a parent workspace directory (will result to selecting all of the
+ nested workspaces)
When set for the `npm init` command, this may be set to the folder of a
workspace which does not yet exist, to create the folder and set it up as a
@@ -1772,20 +1758,12 @@ This value is not exported to the environment for child processes.
#### `workspaces`
-* Default: null
-* Type: null or Boolean
+* Default: false
+* Type: Boolean
-Set to true to run the command in the context of **all** configured
+Enable running a command in the context of **all** the configured
workspaces.
-Explicitly setting this to false will cause commands like `install` to
-ignore workspaces altogether. When not set explicitly:
-
-- Commands that operate on the `node_modules` tree (install, update, etc.)
-will link workspaces into the `node_modules` folder. - Commands that do
-other things (test, exec, publish, etc.) will operate on the root project,
-_unless_ one or more workspaces are specified in the `workspace` config.
-
This value is not exported to the environment for child processes.
<!-- automatically generated, do not edit manually -->