Skip to content

Document debuggerType in launch config, and support string values#5869

Merged
DanTup merged 2 commits intomasterfrom
support-text-debugger-type-and-document
Jan 7, 2026
Merged

Document debuggerType in launch config, and support string values#5869
DanTup merged 2 commits intomasterfrom
support-text-debugger-type-and-document

Conversation

@DanTup
Copy link
Member

@DanTup DanTup commented Jan 7, 2026

Fixes #5855

@DanTup DanTup added this to the v3.128.0 milestone Jan 7, 2026
@DanTup DanTup added is enhancement An enhancement or improvement that should be listed in release notes but is not a bug fix. in debugging Relates to the debug adapter or process of running debug sessions labels Jan 7, 2026
@DanTup DanTup requested a review from Copilot January 7, 2026 13:43
@DanTup
Copy link
Member Author

DanTup commented Jan 7, 2026

@codex review

/gemini review

@gemini-code-assist
Copy link

Hi DanTup,

Thanks for requesting a review! I've looked over your pull request, and it looks great. The changes effectively address the issue of documenting the debuggerType in the launch configuration and supporting string values for it.

Here's a quick summary of my observations:

  • package.json Documentation: The addition of the debuggerType property with its enum values and a clear markdownDescription is excellent. This significantly improves the discoverability and usability of this setting for developers.
  • Robust String-to-Enum Conversion: The debuggerTypeFromString utility function in src/shared/enums.ts is well-implemented. It correctly handles case-insensitivity and filters enum keys, making the conversion reliable.
  • Integration in debug_config_provider.ts: The selectDebuggerType method now gracefully handles both DebuggerType enum values and string representations, with proper validation to ensure only valid types are used. The updated logging message is also helpful for debugging.
  • Comprehensive Testing: The test updates in src/test/dart_debug/debugger_type.test.ts and src/test/shared/debugger_types.ts are thorough, covering the new string-based inputs and case-insensitivity, which is crucial for maintaining the quality of the feature.

Overall, the implementation is clean, well-documented, and thoroughly tested. Great work!

Let me know if you have any further questions.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds documentation for the debuggerType launch configuration option and implements support for string values (e.g., "dart", "flutter") in addition to enum numeric values. This addresses issue #5855 by allowing users to specify debugger types using more readable string names instead of numeric enum values.

  • Added debuggerType configuration documentation to package.json with all valid enum string values
  • Implemented debuggerTypeFromString function for case-insensitive string-to-enum conversion
  • Updated type signatures to accept both DebuggerType enum and string values
  • Added comprehensive test cases for string debugger type values, including case insensitivity

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
package.json Adds debuggerType property definition with enum values and markdown documentation for launch configuration
src/shared/enums.ts Implements debuggerTypeFromString helper function to convert string debugger type names to enum values with case-insensitive matching
src/extension/providers/debug_config_provider.ts Updates selectDebuggerType to accept string values, converts them to enum using helper function, and validates the result
src/test/shared/debugger_types.ts Updates type signature of test helper function to accept string debugger type values
src/test/dart_debug/debugger_type.test.ts Adds test cases for string debugger type values including case insensitivity scenarios
src/test/flutter_debug/debugger_type.test.ts Updates comment to clarify Windows path handling

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e41761f996

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@codecov
Copy link

codecov bot commented Jan 7, 2026

Codecov Report

❌ Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 67.26%. Comparing base (902ea2a) to head (5d530e1).
⚠️ Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
src/shared/enums.ts 75.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5869      +/-   ##
==========================================
- Coverage   67.30%   67.26%   -0.04%     
==========================================
  Files         168      168              
  Lines       12817    12823       +6     
  Branches     2535     2538       +3     
==========================================
- Hits         8627     8626       -1     
- Misses       3744     3749       +5     
- Partials      446      448       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DanTup DanTup merged commit ad641fa into master Jan 7, 2026
21 checks passed
@DanTup DanTup deleted the support-text-debugger-type-and-document branch January 7, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in debugging Relates to the debug adapter or process of running debug sessions is enhancement An enhancement or improvement that should be listed in release notes but is not a bug fix.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support (and document) launch config debuggerType": 0 for both number and string

2 participants