Add support for Yarn workspaces in codemod options and utility functions #123
Conversation
This file contains hidden or 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
- Introduced `--yarn-workspace` option to the codemod CLI. - Implemented `findYarnWorkspaceRoot` utility to locate Yarn workspace root. - Updated `getV1Addons` function to handle Yarn workspace dependencies.
There was a problem hiding this comment.
Pull Request Overview
This PR adds Yarn workspace (monorepo) support to help the codemod correctly locate dependencies in workspace environments where node_modules may be hoisted to the workspace root.
Key changes:
- New
findYarnWorkspaceRoot()utility function to recursively search for workspace root - Added
--yarn-workspaceCLI option to enable workspace-aware dependency resolution - Modified dependency lookup to use workspace root path when in a workspace
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| lib/utils/find-yarn-workspace.js | New utility function to locate Yarn workspace root by walking up directory tree |
| lib/tasks/ensure-v2-addons.js | Updated dependency resolution to support workspace root paths when --yarn-workspace is enabled |
| index.js | Added new --yarn-workspace CLI option |
| README.md | Documented the new --yarn-workspace option in the options table |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The ember-vite-codemod currently cannot correctly locate dependencies when an Ember app or addon is part of a Yarn workspace (monorepo). This causes:
The root cause is that in Yarn workspaces, dependencies are hoisted to the workspace root's
node_modulesdirectory, but the codemod was only looking in the app's local directory.Solution
This PR adds a new
--yarn-workspaceCLI option that enables proper dependency resolution in monorepo environments.Changes:
--yarn-workspaceCLI flag to indicate the app is part of a Yarn workspacelib/utils/find-yarn-workspace.jsutility to locate the workspace root by traversing up the directory tree and finding the workspace'spackage.jsonlib/tasks/ensure-v2-addons.jsto:yarnWorkspaceparameternode_modulesand the workspace root'snode_moduleswhen resolving dependenciesUsage: