Adding Yarn v1.x workspaces metadata extractor #666
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
taylormadore
reviewed
Oct 8, 2024
| ) -> list[Workspace]: | ||
| """Extract workspace metadata from a package. | ||
|
|
||
| Currently does not deal with nested workspaces, however the way the code |
There was a problem hiding this comment.
I remember reading that nested workspaces are not supported: https://classic.yarnpkg.com/lang/en/docs/workspaces/#toc-limitations-caveats
There was a problem hiding this comment.
Yes. I think it is worth mentioning this here anyway.
There was a problem hiding this comment.
Is it? Yarn v1 is maintenance only so nested workspaces aren't happening and so we'd better not confuse the reader with the unlikely possibility of an unplanned feature in the ecosystem.
| ) | ||
|
|
||
|
|
||
| def get_workspace_paths( |
There was a problem hiding this comment.
We should probably ensure that a package.json exists for each workspace we report
There was a problem hiding this comment.
Good point, added a check.
In Yarn v1.x workspaces metadata is stored outside of yarn.lock in package.json. This commit inroduces functions for workspaces metadata extraction and a dataclass to represent workspaces. Signed-off-by: Alexey Ovchinnikov <[email protected]>
a-ovchinnikov
force-pushed
the
yarn_workspace_metadata
branch
from
4539e89
to
5c27f9e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In Yarn v1.x workspaces metadata is stored outside of yarn.lock in package.json. This commit inroduces functions for workspaces metadata extraction and a dataclass to represent workspaces.
This addresses #630
Maintainers will complete the following section
Note: if the contribution is external (not from an organization member), the CI
pipeline will not run automatically. After verifying that the CI is safe to run:
/ok-to-test(as is the standard for Pipelines as Code)