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

Support optional "parent" debug session in "startDebugging" API #70219

Closed
weinand opened this issue Mar 11, 2019 · 0 comments
Closed

Support optional "parent" debug session in "startDebugging" API #70219

weinand opened this issue Mar 11, 2019 · 0 comments
Assignees
Labels
api-finalization debug Debug viewlet, configurations, breakpoints, adapter issues
Milestone

Comments

@weinand
Copy link
Contributor

weinand commented Mar 11, 2019

When starting new debug sessions via the vscode.debug.StartDebugging API, it should be possible to specify a parent debug session so that the VS Code debugging UI can show sessions as a tree.

The proposal adds a new optional argument parent at the end of the existing argument list for startDebugging:

export namespace debug {

  /**
   * Start debugging by using either a named launch or named compound configuration,
   * or by directly passing a [DebugConfiguration](#DebugConfiguration).
   * The named configurations are looked up in '.vscode/launch.json' found in the given folder.
   * Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date.
   * Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.
   * @param folder The [workspace folder](#WorkspaceFolder) for looking up named configurations and resolving variables or `undefined` for a non-folder setup.
   * @param nameOrConfiguration Either the name of a debug or compound configuration or a [DebugConfiguration](#DebugConfiguration) object.
   * @param parent If specified the newly created debug session(s) are registered as "child" sessions under the "parent" debug session.
   * @return A thenable that resolves when debugging could be successfully started.
   */
   export function startDebugging(folder: WorkspaceFolder | undefined, nameOrConfiguration: string | DebugConfiguration, parent?: DebugSession): Thenable<boolean>;

}

One use case can be found here: #62972

@weinand weinand added debug Debug viewlet, configurations, breakpoints, adapter issues api-proposal labels Mar 11, 2019
@weinand weinand added this to the March 2019 milestone Mar 11, 2019
@weinand weinand self-assigned this Mar 11, 2019
@vscodebot vscodebot bot locked and limited conversation to collaborators May 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api-finalization debug Debug viewlet, configurations, breakpoints, adapter issues
Projects
None yet
Development

No branches or pull requests

1 participant