From 4d1d8a9561000064fe765ba31a3ad21832721c59 Mon Sep 17 00:00:00 2001 From: Nathan Fritz Date: Wed, 27 Jul 2022 14:15:21 -0700 Subject: [PATCH] docs: describe implicit workspace and prefix configuration (#5221) * docs: describe implicit workspace and prefix configuration * Update docs/content/using-npm/workspaces.md Co-authored-by: Gar Co-authored-by: Luke Karrys Co-authored-by: Gar --- docs/content/using-npm/workspaces.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/content/using-npm/workspaces.md b/docs/content/using-npm/workspaces.md index 82491cd74af82..5b68ef8ce9d3d 100644 --- a/docs/content/using-npm/workspaces.md +++ b/docs/content/using-npm/workspaces.md @@ -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: @@ -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