A debug configuration provider allows to add debug configurations to the debug service and to resolve launch configurations before they are used to start a debug session. A debug configuration provider is registered via {@link debug.registerDebugConfigurationProvider}.
Fields
optionalresolveDebugConfigurationWithSubstitutedVariables:Null<(folder:Null<WorkspaceFolder>, debugConfiguration:DebugConfiguration, token:CancellationToken) ‑> ProviderResult<DebugConfiguration>>
This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted. It can be used to resolve or verify a {@link DebugConfiguration debug configuration} by filling in missing values or by adding/changing/removing attributes. If more than one debug configuration provider is registered for the same type, the 'resolveDebugConfigurationWithSubstitutedVariables' calls are chained in arbitrary order and the initial debug configuration is piped through the chain. Returning the value 'undefined' prevents the debug session from starting. Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.
@link DebugConfiguration debug configuration} to resolve.
Parameters:
folder | The workspace folder from which the configuration originates from or |
---|---|
debugConfiguration | The { |
token | A cancellation token. |
Returns:
The resolved debug configuration or undefined or null.
optionalresolveDebugConfiguration:Null<(folder:Null<WorkspaceFolder>, debugConfiguration:DebugConfiguration, token:CancellationToken) ‑> ProviderResult<DebugConfiguration>>
Resolves a {@link DebugConfiguration debug configuration} by filling in missing values or by adding/changing/removing attributes. If more than one debug configuration provider is registered for the same type, the resolveDebugConfiguration calls are chained in arbitrary order and the initial debug configuration is piped through the chain. Returning the value 'undefined' prevents the debug session from starting. Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.
@link DebugConfiguration debug configuration} to resolve.
Parameters:
folder | The workspace folder from which the configuration originates from or |
---|---|
debugConfiguration | The { |
token | A cancellation token. |
Returns:
The resolved debug configuration or undefined or null.
optionalprovideDebugConfigurations:Null<(folder:Null<WorkspaceFolder>, token:CancellationToken) ‑> ProviderResult<Array<DebugConfiguration>>>
Provides {@link DebugConfiguration debug configuration} to the debug service. If more than one debug configuration provider is registered for the same type, debug configurations are concatenated in arbitrary order.
@link DebugConfiguration debug configurations}.
Parameters:
folder | The workspace folder for which the configurations are used or |
---|---|
token | A cancellation token. |
Returns:
An array of {