diff options
author | Gar <gar+gh@danger.computer> | 2021-04-01 17:45:21 +0300 |
---|---|---|
committer | Gar <gar+gh@danger.computer> | 2021-04-01 22:44:53 +0300 |
commit | 9237d375b0b7d34c7dc5ba70aec7f616f4133732 (patch) | |
tree | e7801fdceb76922489e7958271fdb192f5d0c14a /docs | |
parent | 4c4252348c538246e1072421d65f4558dc948080 (diff) |
fix(docs): add workspaces configuration
Adds workspaces configuration to `docs`, `repo`, and `set-script`.
PR-URL: https://github.com/npm/cli/pull/3013
Credit: @wraithgar
Close: #3013
Reviewed-by: @darcyclarke
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/commands/npm-docs.md | 13 | ||||
-rw-r--r-- | docs/content/commands/npm-repo.md | 13 | ||||
-rw-r--r-- | docs/content/commands/npm-set-script.md | 15 |
3 files changed, 40 insertions, 1 deletions
diff --git a/docs/content/commands/npm-docs.md b/docs/content/commands/npm-docs.md index c66e5fc62..d0971efa2 100644 --- a/docs/content/commands/npm-docs.md +++ b/docs/content/commands/npm-docs.md @@ -41,6 +41,19 @@ Set to `true` to use default system URL opener. The base URL of the npm package registry. +#### workspaces + +Enables workspaces context while searching the `package.json` in the +current folder. Documentation urls for the packages named in each +workspace will be opened. + +#### workspace + +Enables workspaces context and limits results to only those specified by +this config item. Only the documentation urls for the packages named in +the workspaces given here will be opened. + + ### See Also * [npm view](/commands/npm-view) diff --git a/docs/content/commands/npm-repo.md b/docs/content/commands/npm-repo.md index 670345bec..c3d0da3fd 100644 --- a/docs/content/commands/npm-repo.md +++ b/docs/content/commands/npm-repo.md @@ -31,6 +31,19 @@ terminal. Set to `true` to use default system URL opener. +#### workspaces + +Enables workspaces context while searching the `package.json` in the +current folder. Repo urls for the packages named in each workspace will +be opened. + +#### workspace + +Enables workspaces context and limits results to only those specified by +this config item. Only the repo urls for the packages named in the +workspaces given here will be opened. + + ### See Also * [npm docs](/commands/npm-docs) diff --git a/docs/content/commands/npm-set-script.md b/docs/content/commands/npm-set-script.md index 7bc8f75d2..73e61883c 100644 --- a/docs/content/commands/npm-set-script.md +++ b/docs/content/commands/npm-set-script.md @@ -5,7 +5,7 @@ description: Set tasks in the scripts section of package.json --- ### Synopsis -An npm command that lets you create a task in the scripts section of the package.json. +An npm command that lets you create a task in the `scripts` section of the `package.json`. ```bash npm set-script [<script>] [<command>] @@ -26,6 +26,19 @@ npm set-script [<script>] [<command>] } ``` +### Configuration + +#### workspaces + +Enables workspaces context. Tasks will be created in the `scripts` section +of the `package.json` of each workspace. + +#### workspace + +Enables workspaces context and limits creating a task to the +`package.json` files of the workspaces given. + + ### See Also * [npm run-script](/commands/npm-run-script) |