feat: Add command to generate Metaflow debug configuration#10
Open
Sakshii-27 wants to merge 1 commit intoouterbounds:mainfrom
Open
feat: Add command to generate Metaflow debug configuration#10Sakshii-27 wants to merge 1 commit intoouterbounds:mainfrom
Sakshii-27 wants to merge 1 commit intoouterbounds:mainfrom
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
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.
This PR addresses issue #6 by making it significantly easier for users to debug Metaflow steps directly within VS Code without needing to manually hunt down the correct
launch.jsonconfiguration.As mentioned in the issue, users often struggle with Metaflow debugging because they don't realize they need
"subProcess": trueand"args": ["run", "--max-workers", "1"].To solve this smoothly, I implemented a two-part approach:
extension.generateDebugConfig): Adds aMetaflow: Generate Debug Configcommand to the palette. It intelligently checks for a.vscode/launch.jsonfile in the workspace and safely pushes the perfectMetaflow Debugobject to theconfigurationsarray.DebugConfigurationProvider): Hooked intovscode.debug.registerDebugConfigurationProvider. If a user manually clicks "Add Configuration..." inside the native Run and Debug view, VS Code will proactively offer the "Metaflow Debug" template in their dropdown menu and dynamically inject the snippet.Related Issues
Fixes #6
Testing
Metaflow: Generate Debug Configcorrectly createslaunch.jsonif it doesn't exist, and safely appends toconfigurationsif it does.Visual Proof
1. The Command Palette Option:

2. The Successfully Generated Configuration:
