Skip to content
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

feat(vscode): support running on monorepos #1011

Closed
2 tasks
alestiago opened this issue Sep 7, 2023 · 0 comments · Fixed by #1026
Closed
2 tasks

feat(vscode): support running on monorepos #1011

alestiago opened this issue Sep 7, 2023 · 0 comments · Fixed by #1026
Assignees
Labels
feature A new feature or request

Comments

@alestiago
Copy link
Contributor

alestiago commented Sep 7, 2023

Problem

Currently, the extension detects a Dart Frog project by traversing the file system upwards until it finds a Dart Frog project. If no Dart Frog project is found the vast majority of UI elements provided by the Dart Frog extension are hidden to avoid unnecessarily polluting the user's workspace.

By design, we originally expected users to open a workspace at the root of the Dart Frog project. However, some users do not do so because their workspace is a monorepo with one or more Dart Frog project inside it. This not only hides the Dart Frog's extension UI for them but also running commands such as "Start Development Server" will report:

Failed to find a Dart Frog project within the current workspace.

Currently, the extension can run in a monorepo but this requires the user to have an active route file open.

Proposal

There are multiple solutions, but after discussing with a closed group of users the preferred solution was to:

  1. Traverse the file system downwards to find Dart Frog projects after failing to traverse upwards.
  2. If more than one Dart Frog project is found when traversing downwards, then upon starting a server allow the user to pick their preferred project every single time. If the user finds the prompt annoying, then they should open the preferred Dart Frog project from the root.

Requirements

  • Allow running the extension on monorepos
  • Show user's a quick-pick prompt when there is more than one Dart Frog project on the monorepo and they attempt to run a command that requires a Dart Frog project to be specified
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature or request
Projects
Development

Successfully merging a pull request may close this issue.

1 participant