Design System - BUG - Components Package Yarn Workspace Configured Incorrectly

[TimRoe]

What happened?

While working on #6989, an issue was encountered that running commands from within the components package to other areas of the workspace did not work correctly. Per yarn workspaces functionality, you are supposed to be able to run both root-level and other package-level scripts from any part of the workspace by either:

1. Running yarn workspace <workspaceName> <commandName> ... per the yarn workspace doc or
2. If the script is "global" then it should be able to be run directly from anywhere in the workspace; a "global" script is any script containing a colon in the name (for example, a global command for building the tokens package might be named tokens:build)

These do not work within the components package. They do not work because the workspace should not have their own yarn.lock file, but the components package does. Removing the yarn.lock fixes the workspace problem, but instead causes another issue: doing a full reinstall (e.g. running rm -rf node_modules && yarn install that cleans up any stale node_modules data that could cause problems) does not install the node_modules at the package level (correct), but it also fails to instead look to the workspace-level node_modules that contains all the relevant packages which causes errors (typescript in IDE and crashes trying to run Storybook without dependencies).

Steps to Reproduce

See above.

Desired behavior

Our workspaces are correctly configured so the components package can both leverage workspace functionality and look to workspace-level node_modules.

Once fixed, this may also allow more proper resolution of #6989 since then theoretically setting enableTransparentWorkspaces: false should now work so we could pull the remote version of workspace packages. Alternatively, if that didn't work, at the very least the tokensBuild script in the components package can instead be replaced by a global script (tokens:build) in the tokens package that can simply be called within the components as yarn tokens:build.

Acceptance Criteria

• Fix the components package to work correctly within the yarn workspace
  • Remove the yarn.lock
  • Figure out configuration issues preventing it from looking to the workspace root node_modules for both typescript-level formatting and running Storybook
• Determine if configuring enableTransparentWorkspaces: false at the root .yarnrc.yml will now work for components to leverage the remote tokens instead of local
  • If so, proceed
    • Determine if cross-references also work now and, if so, document somewhere that they can be used for local package testing
  • If not, tweak the BUG - Sev-3 - All - Storybook complains about missing dist/ folder in local dev environment #6989 fix to: have a global script from the tokens package (tokens:build) that can be run in components, remove the components convenience script tokensBuild, and update the setup doc to reflect the change