Skip to content

Commit

Permalink
docs: describe implicit workspace and prefix configuration (#5221)
Browse files Browse the repository at this point in the history
* docs: describe implicit workspace and prefix configuration

* Update docs/content/using-npm/workspaces.md

Co-authored-by: Gar <gar+gh@danger.computer>

Co-authored-by: Luke Karrys <luke@lukekarrys.com>
Co-authored-by: Gar <gar+gh@danger.computer>
  • Loading branch information
3 people committed Jul 27, 2022
1 parent 62b95a0 commit 4d1d8a9
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/content/using-npm/workspaces.md
Expand Up @@ -137,6 +137,8 @@ nested workspaces to be consumed elsewhere.

You can use the `workspace` configuration option to run commands in the context
of a configured workspace.
Additionally, if your current directory is in a workspace, the `workspace`
configuration is implicitly set, and `prefix` is set to the root workspace.

Following is a quick example on how to use the `npm run` command in the context
of nested workspaces. For a project containing multiple workspaces, e.g:
Expand All @@ -158,7 +160,13 @@ given command in the context of that specific workspace. e.g:
npm run test --workspace=a
```

This will run the `test` script defined within the
You could also run the command within the workspace.

```
cd packages/a && npm run test
```

Either will run the `test` script defined within the
`./packages/a/package.json` file.

Please note that you can also specify this argument multiple times in the
Expand Down

0 comments on commit 4d1d8a9

Please sign in to comment.