style(help): yarn workspaces doc
@@ -5,7 +5,8 @@ ${solution_name} runs the Yarn detector if it finds both of the following files
* yarn.lock
* package.json
-The Yarn detector reads both files (at a minimum; see *Yarn workspace support* below)
+The Yarn detector reads both files (see *Yarn workspace support* below for information on
+other files the Yarn detector might read)
to derive project and dependency information.
The yarn.lock file must be up-to-date before ${solution_name} runs.
The package.json file specifies the direct dependencies for the project. ${solution_name} adds these
@@ -19,9 +20,18 @@ ${solution_name} supports projects that use Yarn version 1 or version 2.
## Yarn workspace support
-${solution_name} supports Yarn projects that use workspaces. By default, only workspaces that are dependencies of the
+${solution_name} supports Yarn projects that use workspaces.
+By default, only workspaces that are dependencies of the
root project (directly or indirectly) are included in the produced dependency graph.
+The workspace exclude/include filters can be used to force workspaces to be excluded
+or included.
-TODO: FIX THIS:
-If you set property *detect.yarn.include.all.workspaces* to true,
-*all* workspaces will be included in the results, whether they are dependencies of the root project or not.
\ No newline at end of file
+## Monorepo support
+
+If your root project contains workspaces but does not depend on any of them, you can
+use the workspace include filter to force some or all of the workspaces to be included.
+
+## Using the workspace exclude and include filters
+
+When using the workspace exclude and include filters, specify workspaces by
+name (workspace package.json name field value), not by directory path.
\ No newline at end of file
