Interface DebugConfigurationProvider

A debug configuration provider allows to add the initial debug configurations to a newly created launch.json and to resolve a launch configuration before it is used to start a new debug session. A debug configuration provider is registered via #debug.registerDebugConfigurationProvider.

interface DebugConfigurationProvider {
    provideDebugConfigurations?(folder, token?): ProviderResult<DebugConfiguration[]>;
    resolveDebugConfiguration?(folder, debugConfiguration, token?): ProviderResult<DebugConfiguration>;
    resolveDebugConfigurationWithSubstitutedVariables?(folder, debugConfiguration, token?): ProviderResult<DebugConfiguration>;
}

Methods

  • Resolves a 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.

    Parameters

    Returns ProviderResult<DebugConfiguration>

    The resolved debug configuration or undefined or null.

  • This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted. It can be used to resolve or verify a 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.

    Parameters

    Returns ProviderResult<DebugConfiguration>

    The resolved debug configuration or undefined or null.