add workspaces configs

Add workspaces-related configs: - workspace: list of workspaces names/dir to filter for - workspaces: boolean value to enable/disable workspaces awareness This also adds the proposed note in the docs of each of the commands that are not affected by these configs. Relates to: npm/rfcs#117
npm · Mar 7, 2021 · 7f966c2 · 7f966c2
1 parent 8806015
commit 7f966c2
Show file tree

Hide file tree

Showing 28 changed files with 71 additions and 1 deletion.
diff --git a/docs/content/commands/npm-adduser.md b/docs/content/commands/npm-adduser.md
@@ -12,6 +12,8 @@ npm adduser [--registry=url] [--scope=@orgname] [--always-auth] [--auth-type=leg
 aliases: login, add-user
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Create or verify a user named `<username>` in the specified registry, and

diff --git a/docs/content/commands/npm-bin.md b/docs/content/commands/npm-bin.md
@@ -10,6 +10,8 @@ description: Display npm bin folder
 npm bin [-g|--global]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Print the folder where npm will install executables.

diff --git a/docs/content/commands/npm-cache.md b/docs/content/commands/npm-cache.md
@@ -18,6 +18,8 @@ aliases: npm cache clear, npm cache rm
 npm cache verify
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Used to add, list, or clean the npm cache folder.

diff --git a/docs/content/commands/npm-completion.md b/docs/content/commands/npm-completion.md
@@ -10,6 +10,8 @@ description: Tab Completion for npm
 source <(npm completion)
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Enables tab-completion in all npm commands.

diff --git a/docs/content/commands/npm-config.md b/docs/content/commands/npm-config.md
@@ -18,6 +18,8 @@ npm get [<key> [<key> ...]]
 alias: c
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 npm gets its config settings from the command line, environment

diff --git a/docs/content/commands/npm-deprecate.md b/docs/content/commands/npm-deprecate.md
@@ -10,6 +10,8 @@ description: Deprecate a version of a package
 npm deprecate <pkg>[@<version range>] <message>
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 This command will update the npm registry entry for a package, providing a

diff --git a/docs/content/commands/npm-doctor.md b/docs/content/commands/npm-doctor.md
@@ -10,6 +10,8 @@ description: Check your npm environment
 npm doctor
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 `npm doctor` runs a set of checks to ensure that your npm installation has

diff --git a/docs/content/commands/npm-edit.md b/docs/content/commands/npm-edit.md
@@ -10,6 +10,8 @@ description: Edit an installed package
 npm edit <pkg>
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Selects a dependency in the current project and opens the package folder in

diff --git a/docs/content/commands/npm-explore.md b/docs/content/commands/npm-explore.md
@@ -10,6 +10,8 @@ description: Browse an installed package
 npm explore <pkg> [ -- <command>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Spawn a subshell in the directory of the installed package specified.

diff --git a/docs/content/commands/npm-help-search.md b/docs/content/commands/npm-help-search.md
@@ -10,6 +10,8 @@ description: Search npm help documentation
 npm help-search <text>
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 This command will search the npm markdown documentation files for the terms

diff --git a/docs/content/commands/npm-help.md b/docs/content/commands/npm-help.md
@@ -10,6 +10,8 @@ description: Get help on npm
 npm help <term> [<terms..>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 If supplied a topic, then show the appropriate documentation page.

diff --git a/docs/content/commands/npm-hook.md b/docs/content/commands/npm-hook.md
@@ -13,6 +13,8 @@ npm hook update <id> <url> [secret]
 npm hook rm <id>
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Allows you to manage [npm

diff --git a/docs/content/commands/npm-logout.md b/docs/content/commands/npm-logout.md
@@ -10,6 +10,8 @@ description: Log out of the registry
 npm logout [--registry=<url>] [--scope=<@scope>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 When logged into a registry that supports token-based authentication, tell

diff --git a/docs/content/commands/npm-org.md b/docs/content/commands/npm-org.md
@@ -12,6 +12,8 @@ npm org rm <orgname> <username>
 npm org ls <orgname> [<username>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Example
 
 Add a new developer to an org:

diff --git a/docs/content/commands/npm-owner.md b/docs/content/commands/npm-owner.md
@@ -14,6 +14,8 @@ npm owner ls [<@scope>/]<pkg>
 aliases: author
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Manage ownership of published packages.

diff --git a/docs/content/commands/npm-ping.md b/docs/content/commands/npm-ping.md
@@ -10,6 +10,8 @@ description: Ping npm registry
 npm ping [--registry <registry>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Ping the configured or given npm registry and verify authentication.

diff --git a/docs/content/commands/npm-prefix.md b/docs/content/commands/npm-prefix.md
@@ -10,6 +10,8 @@ description: Display prefix
 npm prefix [-g]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Print the local prefix to standard output. This is the closest parent directory

diff --git a/docs/content/commands/npm-profile.md b/docs/content/commands/npm-profile.md
@@ -14,6 +14,8 @@ npm profile enable-2fa [auth-and-writes|auth-only]
 npm profile disable-2fa
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Change your profile information on the registry.  Note that this command

diff --git a/docs/content/commands/npm-search.md b/docs/content/commands/npm-search.md
@@ -12,6 +12,8 @@ npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms .
 aliases: s, se, find
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Search the registry for packages matching the search terms. `npm search`

diff --git a/docs/content/commands/npm-shrinkwrap.md b/docs/content/commands/npm-shrinkwrap.md
@@ -10,6 +10,8 @@ description: Lock down dependency versions for publication
 npm shrinkwrap
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 This command repurposes `package-lock.json` into a publishable

diff --git a/docs/content/commands/npm-star.md b/docs/content/commands/npm-star.md
@@ -10,6 +10,8 @@ description: Mark your favorite packages
 npm star [<pkg>...]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 "Starring" a package means that you have some interest in it.  It's

diff --git a/docs/content/commands/npm-stars.md b/docs/content/commands/npm-stars.md
@@ -9,6 +9,8 @@ description: View packages marked as favorites
 npm stars [<user>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 If you have starred a lot of neat things and want to find them again

diff --git a/docs/content/commands/npm-team.md b/docs/content/commands/npm-team.md
@@ -16,6 +16,8 @@ npm team rm <scope:team> <user>
 npm team ls <scope>|<scope:team>
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Used to manage teams in organizations, and change team memberships. Does not

diff --git a/docs/content/commands/npm-token.md b/docs/content/commands/npm-token.md
@@ -9,7 +9,9 @@ description: Manage your authentication tokens
   npm token list [--json|--parseable]
   npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16]
   npm token revoke <id|token>
-  ```
+```
+
+Note: This command is unaware of workspaces.
 
 ### Description
 

diff --git a/docs/content/commands/npm-unstar.md b/docs/content/commands/npm-unstar.md
@@ -10,6 +10,8 @@ description: Remove an item from your favorite packages
 npm unstar [<pkg>...]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 "Unstarring" a package is the opposite of [`npm star`](/commands/npm-star),

diff --git a/docs/content/commands/npm-whoami.md b/docs/content/commands/npm-whoami.md
@@ -10,6 +10,8 @@ description: Display npm username
 npm whoami [--registry <registry>]
 ```
 
+Note: This command is unaware of workspaces.
+
 ### Description
 
 Print the `username` config to standard output.

diff --git a/lib/utils/config.js b/lib/utils/config.js
@@ -192,6 +192,8 @@ const defaults = {
   version: false,
   versions: false,
   viewer: isWindows ? 'browser' : 'man',
+  workspace: [],
+  workspaces: false,
 }
 
 const types = {
@@ -348,6 +350,8 @@ const types = {
   version: Boolean,
   versions: Boolean,
   viewer: String,
+  workspace: [String, Array],
+  workspaces: Boolean
 }
 
 const shorthands = {

diff --git a/tap-snapshots/test-lib-utils-config.js-TAP.test.js b/tap-snapshots/test-lib-utils-config.js-TAP.test.js
@@ -149,6 +149,8 @@ Object {
     "version": false,
     "versions": false,
     "viewer": "browser",
+    "workspace": Array [],
+    "workspaces": false,
   },
   "shorthands": Object {
     "?": Array [
@@ -552,6 +554,11 @@ Object {
     "version": "{Boolean TYPE}",
     "versions": "{Boolean TYPE}",
     "viewer": "{String TYPE}",
+    "workspace": Array [
+      "{String TYPE}",
+      "{Array TYPE}",
+    ],
+    "workspaces": "{Boolean TYPE}",
   },
 }
 `
@@ -700,6 +707,8 @@ Object {
     "version": false,
     "versions": false,
     "viewer": "man",
+    "workspace": Array [],
+    "workspaces": false,
   },
   "shorthands": Object {
     "?": Array [
@@ -1105,6 +1114,11 @@ Object {
     "version": "{Boolean TYPE}",
     "versions": "{Boolean TYPE}",
     "viewer": "{String TYPE}",
+    "workspace": Array [
+      "{String TYPE}",
+      "{Array TYPE}",
+    ],
+    "workspaces": "{Boolean TYPE}",
   },
 }
 `