feat(workspaces): --include-workspace-root

[wraithgar]

Adds a new config item that includes the workspace root when running
non-arborist commands (i.e. repo, version, publish). Arborist will need
to be udpated to look for this flag to change its behavior to include
the workspace root for its functions.

This also changes --workspaces to a trinary, so that setting it to false
will explicitly exclude workspaces altogether. This is also going to
require an arborist change so that it ignores workspaces altogether.

Closes npm/statusboard#371

[wraithgar]

Probably want to add to usage and/or docs for this.

[wraithgar]

This still doesn't solve the problem of "run this command under the context of all workspaces and also my local workspace"

Also, given the fact that right now including a workspace also includes all ITS workspaces, we may need to either rethink this, or make sure we're very clear in the docs what this is for.

[ljharb]

Using . certainly shouldn’t also include transitive workspaces, that defeats the entire point of using it.

[wraithgar]

Using . certainly shouldn’t also include transitive workspaces, that defeats the entire point of using it.

It doesn't, but there is a bit of a mental model for arborist-related commands that if I include a workspace (for instance during install) then its workspaces are also included). I don't think this is a problem.

Current thinking is:

• -ws adds all workspaces to the current context i.e. npm run test -ws runs tests in all workspaces.
• -ws by default does not include the current project as a context (this is the current behavior already)
• -w . can be combined with -ws to effect the desired run this command in all my workspaces AND my root project
• -w . can be used in isolation (this is most needed for arborist related commands) to exclude all workspaces from the task

It does seem that there is already a bit of a confusion between the mental models for arborist-related things, and the other commands e.g. ls, run, repo. It is what it is at this point we just have to try to not make it worse if we can help it.

[ljharb]

I like the current thinking.

Personally i prefer the long form for all my CLI args; it makes things much clearer to think about.

[wraithgar]

Treating . as a workspace has lots of other unintended problems because we don't actually ever treat it as a workspace.

We're gonna instead use a specific --include-workspace-root flag (still needs a good shorthand).

[ljharb]

The . is particularly nice for configs - i use it in lerna - but for cli invocations this should work the same.

[wraithgar]

Default:
  Command is ran under the context of the root project only
  Workspaces are used in node_modules if the name matches the required dependency

--workspaces
  Command is ran under the context of every workspace
  Command is not ran under the context fo the root project
  Workspaces are used in node_modules if the name matches the required dependency

--workspace x
  Command is ran under the context of workspace x
  Command is not ran under the context fo the root project
  Workspaces are used in node_modules if the name matches the required dependency


--workspace x --include-workspace-root
  Command is ran under the context of workspace x
  Command is also ran under the context of the root project
  Workspaces are used in node_modules if the name matches the required dependency


--no-workspaces
  Command is ran under the context of the root project only
  Workspaces are not used in node_modules

--no-workspaces --include-workspace-root
  Redundant

--no-workspaces --workspace x
  Throws an exception

[wraithgar]

Exception throw isn't done yet, just realized.

[wraithgar]

This was implemented in #3890