Class PluginDebugService

Debug service to work with plugin and extension contributions.

Implements

DebugService

Index

Constructors

Properties

configurationProviders connectionProvider contributors debuggers delegated 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

fireOnDidConfigurationProvidersChanged

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

Type declaration

- (): void
- Returns void

`Protected` `Readonly` onDidChangeDebugConfigurationProvidersEmitter

onDidChangeDebugConfigurationProvidersEmitter: Emitter<void> = ...

`Protected` `Readonly` onDidChangeDebuggersEmitter

onDidChangeDebuggersEmitter: Emitter<void> = ...

`Protected` `Readonly` sessionId2contrib

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

`Protected` `Readonly` toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly` workspaceService

workspaceService: WorkspaceService

Accessors

onDidChangeDebugConfigurationProviders

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

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, workspaceFolder): Promise<string>
Parameters
- config: DebugConfiguration
- workspaceFolder: undefined | string
Returns Promise<string>
Implementation of DebugService.createDebugSession
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:403

debugTypes

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

dispose

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

fetchDynamicDebugConfiguration

fetchDynamicDebugConfiguration(name, providerType, folder?): Promise<undefined | DebugConfiguration>
Parameters
- name: string
- providerType: string
- Optional folder: string
Returns Promise<undefined | DebugConfiguration>
Implementation of DebugService.fetchDynamicDebugConfiguration
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:152

getConfigurationSnippets

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

getDebuggersForLanguage

getDebuggersForLanguage(language): 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:284

getSchemaAttributes

getSchemaAttributes(debugType): Promise<IJSONSchema[]>
Parameters
- debugType: string
Returns Promise<IJSONSchema[]>
Implementation of DebugService.getSchemaAttributes
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:298

`Protected` init

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

provideDebugConfigurations

provideDebugConfigurations(debugType, workspaceFolderUri): Promise<DebugConfiguration[]>
Parameters
- debugType: keyof DebugRequestTypes
- workspaceFolderUri: undefined | string
Returns Promise<DebugConfiguration[]>
Implementation of DebugService.provideDebugConfigurations
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:129

provideDebuggerVariables

provideDebuggerVariables(debugType): Promise<CommandIdVariables>
Parameters
- debugType: string
Returns Promise<CommandIdVariables>
Implementation of DebugService.provideDebuggerVariables
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:272

provideDynamicDebugConfigurations

provideDynamicDebugConfigurations(folder?): Promise<Record<string, DebugConfiguration[]>>
Parameters
- Optional folder: string
Returns Promise<Record<string, DebugConfiguration[]>>
Implementation of DebugService.provideDynamicDebugConfigurations
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:170

registerDebugAdapterContribution

registerDebugAdapterContribution(contrib): Disposable
Parameters
- contrib: PluginDebugAdapterContribution
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:78

registerDebugConfigurationProvider

registerDebugConfigurationProvider(provider): Disposable
Parameters
- provider: PluginDebugConfigurationProvider
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:99

registerDebugger

registerDebugger(contribution): Disposable
Parameters
- contribution: DebuggerContribution
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:262

resolveDebugConfiguration

resolveDebugConfiguration(config, workspaceFolderUri): Promise<undefined | null | DebugConfiguration>
Parameters
- config: DebugConfiguration
- workspaceFolderUri: undefined | string
Returns Promise<undefined | null | DebugConfiguration>
Implementation of DebugService.resolveDebugConfiguration
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:192

`Protected` resolveDebugConfigurationByResolversChain

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

resolveDebugConfigurationWithSubstitutedVariables

resolveDebugConfigurationWithSubstitutedVariables(config, workspaceFolderUri): Promise<undefined | null | DebugConfiguration>
Parameters
- config: DebugConfiguration
- workspaceFolderUri: undefined | string
Returns Promise<undefined | null | DebugConfiguration>
Implementation of DebugService.resolveDebugConfigurationWithSubstitutedVariables
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:214

`Protected` resolveSchemaAttributes

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

terminateDebugSession

terminateDebugSession(sessionId): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
Implementation of DebugService.terminateDebugSession
- Defined in packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts:414

unregisterDebugAdapterContribution

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

unregisterDebugConfigurationProvider

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

Class PluginDebugService

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PluginDebugService

Properties

Protected Readonly configurationProviders

Protected Readonly connectionProvider

Protected Readonly contributors

Protected Readonly debuggers

Protected delegated

fireOnDidConfigurationProvidersChanged

Type declaration

Returns void

Protected Readonly onDidChangeDebugConfigurationProvidersEmitter

Protected Readonly onDidChangeDebuggersEmitter

Protected Readonly sessionId2contrib

Protected Readonly toDispose

Protected Readonly workspaceService

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[]>

getDebuggersForLanguage

Parameters

Returns Promise<DebuggerDescription[]>

getSchemaAttributes

Parameters

Returns Promise<IJSONSchema[]>

Protected init

Returns void

provideDebugConfigurations

Parameters

Returns Promise<DebugConfiguration[]>

provideDebuggerVariables

Parameters

Returns Promise<CommandIdVariables>

provideDynamicDebugConfigurations

Parameters

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

registerDebugAdapterContribution

Parameters

Returns Disposable

registerDebugConfigurationProvider

Parameters

Returns Disposable

registerDebugger

Parameters

Returns Disposable

resolveDebugConfiguration

Parameters

Returns Promise<undefined | null | DebugConfiguration>

Protected resolveDebugConfigurationByResolversChain

Parameters

Returns Promise<undefined | null | DebugConfiguration>

resolveDebugConfigurationWithSubstitutedVariables

Parameters

Returns Promise<undefined | null | DebugConfiguration>

Protected resolveSchemaAttributes

Parameters

[request: string]: IJSONSchema

`Protected` `Readonly` configurationProviders

`Protected` `Readonly` connectionProvider

`Protected` `Readonly` contributors

`Protected` `Readonly` debuggers

`Protected` delegated

`Protected` `Readonly` onDidChangeDebugConfigurationProvidersEmitter

`Protected` `Readonly` onDidChangeDebuggersEmitter

`Protected` `Readonly` sessionId2contrib

`Protected` `Readonly` toDispose

`Protected` `Readonly` workspaceService

`Protected` init

`Protected` resolveDebugConfigurationByResolversChain

`Protected` resolveSchemaAttributes