-
Notifications
You must be signed in to change notification settings - Fork 239
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[RRFC] Improving workspace terminology #430
Comments
Specifically, if the qualifier “root” and/or “child” is necessary to disambiguate the term “workspace”, then it is far from an ideal choice. |
Comments from rfc call:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Motivation
Based on discussions from npm/feedback#510 and a few other issues.
The purpose of this issue is to resolve the confusion of using the term "workspace" or "workspaces". There are contradictions among the RFC which interchanges between packages and workspaces.
RFC: https://github.com/npm/rfcs/blob/latest/implemented/0026-workspaces.md
For e.g I believe a workspace is the top-level folder which holds all of the packages that you work in. But the child-projects which can be published to npm are packages.
The community seems to settle on this also: A workspace is what npm calls a monorepo: A directory with subdirectories that are npm packages. https://2ality.com/2021/07/simple-monorepos.html#npm-workspaces
In dictionary we have a definition:
So my understanding here is top-level workspace is a package that containers configuration defining more (inner) workspaces. So it sounds like the inner packages are also called workspaces?
Examples
The example lists them as packages.
So are they packages or workspaces?
The summary of the RFC calls them packages also:
and the motivation
Desired Behaviour
"Workspace" refers to the outer folder which holds the packages, and "package" refers to each individual package residing inside the workspace. "top-level workspace" no longer needs to exist.
The code used in the package.json already follows this convention (see above) so its mostly updating the RFC.
Shipping Changes
There should be no changes to the functionality of Workspaces.
References
#103
The text was updated successfully, but these errors were encountered: