Class PluginDebugService

Debug service to work with plugin and extension contributions.

Implements

DebugService

Index

Constructors

Properties

configurationProviders connectionProvider contributors debuggers delegated dynamicDebugConfigsFromManifests fireOnDidConfigurationProvidersChanged onDidChangeDebugConfigurationProvidersEmitter onDidChangeDebuggersEmitter sessionId2contrib toDispose workspaceService

Accessors

onDidChangeDebugConfigurationProviders onDidChangeDebuggers

Constructors

constructor

new PluginDebugService(): PluginDebugService
Returns PluginDebugService

Properties

`Protected` `Readonly`configurationProviders

configurationProviders: Map<number, PluginDebugConfigurationProvider> = ...

`Protected` `Readonly`connectionProvider

connectionProvider: WebSocketConnectionProvider

`Protected` `Readonly`contributors

contributors: Map<string, PluginDebugAdapterContribution> = ...

`Protected` `Readonly`debuggers

debuggers: DebuggerContribution[] = []

`Protected`delegated

delegated: DebugService

`Protected` `Readonly`dynamicDebugConfigsFromManifests

dynamicDebugConfigsFromManifests: Map<
string,
{ label: string; refCount: number },
> = ...

Debug configurations discovered from plugin manifests (activation events) before providers register. Maps type -> { label, refCount } since multiple plugins may register the same type.

fireOnDidConfigurationProvidersChanged

fireOnDidConfigurationProvidersChanged: DebouncedFunc<() => void> = ...

debouncing to send a single notification for multiple registrations at initialization time

`Protected` `Readonly`onDidChangeDebugConfigurationProvidersEmitter

onDidChangeDebugConfigurationProvidersEmitter: Emitter<void> = ...

`Protected` `Readonly`onDidChangeDebuggersEmitter

onDidChangeDebuggersEmitter: Emitter<void> = ...

`Protected` `Readonly`sessionId2contrib

sessionId2contrib: Map<string, PluginDebugAdapterContribution> = ...

maps session and contribution

`Protected` `Readonly`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

onDidChangeDebugConfigurationProviders

get onDidChangeDebugConfigurationProviders(): Event<void>
Event handle to indicate when one or more dynamic debug configuration providers have been registered or unregistered.

Returns Event<void>
Implementation of DebugService.onDidChangeDebugConfigurationProviders
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:55

onDidChangeDebuggers

get onDidChangeDebuggers(): Event<void>
Returns Event<void>
Implementation of DebugService.onDidChangeDebuggers
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:41

Methods

createDebugSession

createDebugSession(
config: DebugConfiguration,
workspaceFolder: undefined | string,
): Promise<string>
Creates a new debug adapter session.
Parameters
- config: DebugConfiguration
  The resolved debug configuration.
- workspaceFolder: undefined | string
  The workspace folder for this sessions or undefined when folderless
Returns Promise<string>
The identifier of the created debug adapter session.
Implementation of DebugService.createDebugSession
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:513

debugTypes

debugTypes(): Promise<string[]>
Finds and returns an array of registered debug types.

Returns Promise<string[]>
An array of registered debug types
Implementation of DebugService.debugTypes
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:123

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of DebugService.dispose
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:534

fetchDynamicDebugConfiguration

fetchDynamicDebugConfiguration(
    name: string,
    providerType: string,
    folder?: string,
): Promise<undefined | DebugConfiguration>
Provides a dynamic debug configuration matching the name and the provider debug type
Parameters
- name: string
- providerType: string
- Optionalfolder: string
Returns Promise<undefined | DebugConfiguration>
Implementation of DebugService.fetchDynamicDebugConfiguration
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:157

getConfigurationSnippets

getConfigurationSnippets(): Promise<IJSONSchemaSnippet[]>
Returns Promise<IJSONSchemaSnippet[]>
Implementation of DebugService.getConfigurationSnippets
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:501

`Protected`getDebuggerLabel

getDebuggerLabel(type: string): undefined | string
Gets the label for a debugger type.
Parameters
- type: string
Returns undefined | string
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:245

getDebuggersForLanguage

getDebuggersForLanguage(language: string): Promise<DebuggerDescription[]>
Parameters
- language: string
Returns Promise<DebuggerDescription[]>
Implementation of DebugService.getDebuggersForLanguage
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:389

getDynamicDebugConfigurationProviders

getDynamicDebugConfigurationProviders(): DynamicDebugConfigurationProvider[]
Returns dynamic debug configuration providers grouped by label. Each entry contains a label and all the types that share that label. Includes both registered providers and types discovered from plugin manifests.

Returns DynamicDebugConfigurationProvider[]
Implementation of DebugService.getDynamicDebugConfigurationProviders
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:205

getDynamicDebugConfigurationProviderTypes

getDynamicDebugConfigurationProviderTypes(): string[]
Returns the types of dynamic debug configuration providers.

Returns string[]
Deprecated
Use getDynamicDebugConfigurationProviders() instead for proper label support.
Implementation of DebugService.getDynamicDebugConfigurationProviderTypes
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:238

getSchemaAttributes

getSchemaAttributes(debugType: string): Promise<IJSONSchema[]>
Provides the schema attributes.
Parameters
- debugType: string
  The registered debug type
Returns Promise<IJSONSchema[]>
An JSON Schema describing the configuration attributes for the given debug type
Implementation of DebugService.getSchemaAttributes
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:403

`Protected`init

init(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:69

provideDebugConfigurations

provideDebugConfigurations(
debugType: keyof DebugRequestTypes,
workspaceFolderUri: undefined | string,
): Promise<DebugConfiguration[]>
Provides initial debug configuration.
Parameters
- debugType: keyof DebugRequestTypes
  The registered debug type
- workspaceFolderUri: undefined | string
Returns Promise<DebugConfiguration[]>
An array of debug configurations
Implementation of DebugService.provideDebugConfigurations
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:134

provideDebuggerVariables

provideDebuggerVariables(debugType: string): Promise<CommandIdVariables>
Provide debugger contributed variables see "variables" at https://code.visualstudio.com/api/references/contribution-points#contributes.debuggers
Parameters
- debugType: string
Returns Promise<CommandIdVariables>
Implementation of DebugService.provideDebuggerVariables
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:377

provideDynamicDebugConfigurations

provideDynamicDebugConfigurations(
folder?: string,
): Promise<Record<string, DebugConfiguration[]>>
Parameters
- Optionalfolder: string
Returns Promise<Record<string, DebugConfiguration[]>>
A Record of debug configuration provider types and a corresponding dynamic debug configurations array
Implementation of DebugService.provideDynamicDebugConfigurations
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:250

provideDynamicDebugConfigurationsByType

provideDynamicDebugConfigurationsByType(
type: string,
folder?: string,
): Promise<DebugConfiguration[]>
Provides dynamic debug configurations for a specific provider type only. This is more efficient than provideDynamicDebugConfigurations when you only need configurations for a single type.
Parameters
- type: string
- Optionalfolder: string
Returns Promise<DebugConfiguration[]>
Implementation of DebugService.provideDynamicDebugConfigurationsByType
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:277

registerDynamicDebugConfigurationType

registerDynamicDebugConfigurationType(type: string, label: string): Disposable
Registers a dynamic debug configuration type discovered from a plugin manifest. This allows showing provider types in the dropdown before the extension has activated.
Parameters
- type: string
- label: string
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:179

resolveDebugConfiguration

resolveDebugConfiguration(
config: DebugConfiguration,
workspaceFolderUri: undefined | string,
): Promise<undefined | null | DebugConfiguration>
Resolves a debug configuration by filling in missing values or by adding/changing/removing attributes before variable substitution.
Parameters
- config: DebugConfiguration
- workspaceFolderUri: undefined | string
Returns Promise<undefined | null | DebugConfiguration>
The resolved debug configuration, undefined or null.
Implementation of DebugService.resolveDebugConfiguration
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:297

`Protected`resolveDebugConfigurationByResolversChain

resolveDebugConfigurationByResolversChain(
    config: DebugConfiguration,
    workspaceFolderUri: undefined | string,
    resolvers: (
        (
            folder: undefined | string,
            debugConfiguration: DebugConfiguration,
        ) => Promise<undefined | null | DebugConfiguration>
    )[],
): Promise<undefined | null | DebugConfiguration>
Parameters
- config: DebugConfiguration
- workspaceFolderUri: undefined | string
- resolvers: (
      (
          folder: undefined | string,
          debugConfiguration: DebugConfiguration,
      ) => Promise<undefined | null | DebugConfiguration>
  )[]
Returns Promise<undefined | null | DebugConfiguration>
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:343

resolveDebugConfigurationWithSubstitutedVariables

resolveDebugConfigurationWithSubstitutedVariables(
config: DebugConfiguration,
workspaceFolderUri: undefined | string,
): Promise<undefined | null | DebugConfiguration>
Resolves a debug configuration by filling in missing values or by adding/changing/removing attributes with substituted variables.
Parameters
- config: DebugConfiguration
- workspaceFolderUri: undefined | string
Returns Promise<undefined | null | DebugConfiguration>
The resolved debug configuration, undefined or null.
Implementation of DebugService.resolveDebugConfigurationWithSubstitutedVariables
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:319

`Protected`resolveSchemaAttributes

resolveSchemaAttributes(
type: string,
configurationAttributes: { [request: string]: IJSONSchema },
): IJSONSchema[]
Parameters
- type: string
- configurationAttributes: { [request: string]: IJSONSchema }
Returns IJSONSchema[]
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:414

terminateDebugSession

terminateDebugSession(sessionId: string): Promise<void>
Stop a running session for the given session id.
Parameters
- sessionId: string
Returns Promise<void>
Implementation of DebugService.terminateDebugSession
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:524

unregisterDebugAdapterContribution

unregisterDebugAdapterContribution(debugType: string): void
Parameters
- debugType: string
Returns void
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:95

unregisterDebugConfigurationProvider

unregisterDebugConfigurationProvider(handle: number): void
Parameters
- handle: number
Returns void
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:118

Class PluginDebugService

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PluginDebugService

Properties

Protected ReadonlyconfigurationProviders

Protected ReadonlyconnectionProvider

Protected Readonlycontributors

Protected Readonlydebuggers

Protecteddelegated

Protected ReadonlydynamicDebugConfigsFromManifests

fireOnDidConfigurationProvidersChanged

Protected ReadonlyonDidChangeDebugConfigurationProvidersEmitter

Protected ReadonlyonDidChangeDebuggersEmitter

Protected ReadonlysessionId2contrib

Protected ReadonlytoDispose

Protected ReadonlyworkspaceService

Accessors

onDidChangeDebugConfigurationProviders

Returns Event<void>

onDidChangeDebuggers

Returns Event<void>

Methods

createDebugSession

Parameters

Returns Promise<string>

debugTypes

Returns Promise<string[]>

dispose

Returns void

fetchDynamicDebugConfiguration

Parameters

Returns Promise<undefined | DebugConfiguration>

getConfigurationSnippets

Returns Promise<IJSONSchemaSnippet[]>

ProtectedgetDebuggerLabel

Parameters

Returns undefined | string

getDebuggersForLanguage

Parameters

Returns Promise<DebuggerDescription[]>

getDynamicDebugConfigurationProviders

Returns DynamicDebugConfigurationProvider[]

getDynamicDebugConfigurationProviderTypes

Returns string[]

Deprecated

getSchemaAttributes

Parameters

Returns Promise<IJSONSchema[]>

Protectedinit

Returns void

provideDebugConfigurations

Parameters

Returns Promise<DebugConfiguration[]>

provideDebuggerVariables

Parameters

Returns Promise<CommandIdVariables>

provideDynamicDebugConfigurations

Parameters

Returns Promise<Record<string, DebugConfiguration[]>>

provideDynamicDebugConfigurationsByType

Parameters

Returns Promise<DebugConfiguration[]>

registerDebugAdapterContribution

Parameters

Returns Disposable

registerDebugConfigurationProvider

Parameters

Returns Disposable

registerDebugger

Parameters

Returns Disposable

registerDynamicDebugConfigurationType

Parameters

`Protected` `Readonly`configurationProviders

`Protected` `Readonly`connectionProvider

`Protected` `Readonly`contributors

`Protected` `Readonly`debuggers

`Protected`delegated

`Protected` `Readonly`dynamicDebugConfigsFromManifests

`Protected` `Readonly`onDidChangeDebugConfigurationProvidersEmitter

`Protected` `Readonly`onDidChangeDebuggersEmitter

`Protected` `Readonly`sessionId2contrib

`Protected` `Readonly`toDispose

`Protected` `Readonly`workspaceService

`Protected`getDebuggerLabel

`Protected`init

`Protected`resolveDebugConfigurationByResolversChain

`Protected`resolveSchemaAttributes