Class DebugConfigurationManager

Index

Constructors

constructor

Accessors

all current onDidChangeConfigurationProviders onWillProvideDynamicDebugConfiguration recentDynamicOptions supported

Constructors

constructor

new DebugConfigurationManager(): DebugConfigurationManager
Returns DebugConfigurationManager

Properties

`Protected`_currentOptions

_currentOptions: undefined | DebugSessionOptions

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly`debug

debug: DebugService

`Protected`debugConfigurationTypeKey

debugConfigurationTypeKey: ContextKey<string>

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected`initialized

initialized: Promise<void>

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`models

models: Map<string, DebugConfigurationModel> = ...

`Readonly`onDidChange

onDidChange: Event<void> = ...

`Readonly`onDidChangeDynamicConfigurations

onDidChangeDynamicConfigurations: Event<void> = ...

Fires when the set of dynamic debug configuration providers changes (i.e., when providers are registered or unregistered).

`Protected` `Readonly`onDidChangeDynamicConfigurationsEmitter

onDidChangeDynamicConfigurationsEmitter: Emitter<void> = ...

`Protected` `Readonly`onDidChangeEmitter

onDidChangeEmitter: Emitter<void> = ...

`Readonly`onWillProvideDebugConfiguration

onWillProvideDebugConfiguration: Event<WillProvideDebugConfiguration> = ...

`Protected` `Readonly`onWillProvideDebugConfigurationEmitter

onWillProvideDebugConfigurationEmitter: Emitter<WillProvideDebugConfiguration> = ...

`Protected` `Readonly`onWillProvideDynamicDebugConfigurationEmitter

onWillProvideDynamicDebugConfigurationEmitter: Emitter<
WillProvideDebugConfiguration,
> = ...

`Protected` `Readonly`preferenceConfigurations

preferenceConfigurations: PreferenceConfigurations

`Protected` `Readonly`preferences

preferences: PreferenceService

`Protected` `Readonly`quickPickService

quickPickService: QuickPickService

`Protected`updateModels

updateModels: (...arguments: []) => Promise<void> = ...

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

`Protected` `Readonly`workspaceVariables

workspaceVariables: WorkspaceVariableContribution

Accessors

all

get all(): IterableIterator<DebugSessionOptions>
All non-dynamic debug configurations.

Returns IterableIterator<DebugSessionOptions>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:164

current

get current(): undefined | DebugSessionOptions
Returns undefined | DebugSessionOptions
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:195
set current(option: undefined | DebugSessionOptions): void
Parameters
- option: undefined | DebugSessionOptions
Returns void
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:219

onDidChangeConfigurationProviders

get onDidChangeConfigurationProviders(): Event<void>
Returns Event<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:99

onWillProvideDynamicDebugConfiguration

get onWillProvideDynamicDebugConfiguration(): Event<
WillProvideDebugConfiguration,
>
Returns Event<WillProvideDebugConfiguration>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:95

recentDynamicOptions

get recentDynamicOptions(): readonly DynamicDebugConfigurationSessionOptions[]
Returns readonly DynamicDebugConfigurationSessionOptions[]
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:247

supported

get supported(): Promise<IterableIterator<DebugSessionOptions, any, any>>
Returns Promise<IterableIterator<DebugSessionOptions, any, any>>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:178

Methods

addConfiguration

addConfiguration(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:351

`Protected`compoundToOptions

compoundToOptions(
compound: DebugCompound,
workspaceFolderUri?: string,
): DebugSessionOptions
Parameters
- compound: DebugCompound
- OptionalworkspaceFolderUri: string
Returns DebugSessionOptions
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:347

`Protected`configurationToOptions

configurationToOptions(
    configuration: DebugConfiguration,
    workspaceFolderUri?: string,
    providerType?: string,
): DebugSessionOptions
Parameters
- configuration: DebugConfiguration
- OptionalworkspaceFolderUri: string
- OptionalproviderType: string
Returns DebugSessionOptions
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:343

`Protected`doCreate

doCreate(model: DebugConfigurationModel): Promise<URI>
Parameters
- model: DebugConfigurationModel
Returns Promise<URI>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:448

`Protected`doGetSupported

doGetSupported(debugTypes: Set<string>): IterableIterator<DebugSessionOptions>
Parameters
- debugTypes: Set<string>
Returns IterableIterator<DebugSessionOptions>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:186

`Protected`doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:125

`Protected`doOpen

doOpen(model: DebugConfigurationModel): Promise<EditorWidget>
Parameters
- model: DebugConfigurationModel
Returns Promise<EditorWidget>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:440

`Protected`dynamicOptionsMatch

dynamicOptionsMatch(
one: DynamicDebugConfigurationSessionOptions,
other: DynamicDebugConfigurationSessionOptions,
): boolean
Parameters
- one: DynamicDebugConfigurationSessionOptions
- other: DynamicDebugConfigurationSessionOptions
Returns boolean
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:240

`Protected`ensureContent

ensureContent(uri: URI, model: DebugConfigurationModel): Promise<void>
Checks whether a launch.json file contains the minimum necessary content. If content not found, provides content and populates the file using Monaco.
Parameters
- uri: URI
- model: DebugConfigurationModel
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:465

fetchDynamicDebugConfiguration

fetchDynamicDebugConfiguration(
    name: string,
    type: string,
    folder?: string,
): Promise<undefined | DebugConfiguration>
Parameters
- name: string
- type: string
- Optionalfolder: string
Returns Promise<undefined | DebugConfiguration>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:539

find

find(name: string, workspaceFolderUri: string): undefined | DebugSessionOptions
Parameters
- name: string
- workspaceFolderUri: string
Returns undefined | DebugSessionOptions
Deprecated
since v1.27.0
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:274
find(
compound: DebugCompound,
workspaceFolderUri?: string,
): undefined | DebugSessionOptions
Find / Resolve DebugSessionOptions from a given target debug configuration
Parameters
- compound: DebugCompound
- OptionalworkspaceFolderUri: string
Returns undefined | DebugSessionOptions
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:278
find(
    configuration: DebugConfiguration,
    workspaceFolderUri?: string,
    providerType?: string,
): undefined | DebugSessionOptions
Parameters
- configuration: DebugConfiguration
- OptionalworkspaceFolderUri: string
- OptionalproviderType: string
Returns undefined | DebugSessionOptions
Deprecated
since v1.27.0
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:279
find(
    name: string,
    workspaceFolderUri?: string,
    providerType?: string,
): undefined | DebugSessionOptions
Parameters
- name: string
- OptionalworkspaceFolderUri: string
- OptionalproviderType: string
Returns undefined | DebugSessionOptions
Deprecated
since v1.27.0
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:280

findCompound

findCompound(
name: string,
workspaceFolderUri?: string,
): undefined | DebugCompound
Parameters
- name: string
- OptionalworkspaceFolderUri: string
Returns undefined | DebugCompound
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:323

findConfiguration

findConfiguration(
name: string,
workspaceFolderUri?: string,
): undefined | DebugConfiguration
Parameters
- name: string
- OptionalworkspaceFolderUri: string
Returns undefined | DebugConfiguration
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:311

findConfigurations

findConfigurations(
name: string,
workspaceFolderUri?: string,
): DebugConfiguration[]
Parameters
- name: string
- OptionalworkspaceFolderUri: string
Returns DebugConfiguration[]
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:297

`Protected`fireWillProvideDebugConfiguration

fireWillProvideDebugConfiguration(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:487

`Protected`fireWillProvideDynamicDebugConfiguration

fireWillProvideDynamicDebugConfiguration(debugType?: string): Promise<void>
Parameters
- OptionaldebugType: string
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:568

`Protected`getAll

getAll(): IterableIterator<DebugSessionOptions>
Returns IterableIterator<DebugSessionOptions>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:167

getDynamicDebugConfigurationProviders

getDynamicDebugConfigurationProviders(): DynamicDebugConfigurationProvider[]
Returns dynamic debug configuration providers grouped by label. Each entry contains a label and all the types that share that label.

Returns DynamicDebugConfigurationProvider[]
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:495

getDynamicDebugConfigurationProviderTypes

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

Returns string[]
Deprecated
Use getDynamicDebugConfigurationProviders() instead for proper label support.
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:504

`Protected`getInitialConfigurationContent

getInitialConfigurationContent(
initialConfigurations: DebugConfiguration[],
): string
Parameters
- initialConfigurations: DebugConfiguration[]
Returns string
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:573

`Protected`getModel

getModel(uri?: URI): undefined | DebugConfigurationModel
Parameters
- Optionaluri: URI
Returns undefined | DebugConfigurationModel
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:422

getSelectedConfiguration

getSelectedConfiguration(): Promise<undefined | DebugSessionOptions>
Returns Promise<undefined | DebugSessionOptions>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:199

`Protected`getSupported

getSupported(): Promise<IterableIterator<DebugSessionOptions, any, any>>
Returns Promise<IterableIterator<DebugSessionOptions, any, any>>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:181

`Protected`init

init(): void
Returns void
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:117

load

load(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:601

openConfiguration

openConfiguration(): Promise<void>
Returns Promise<void>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:335

`Protected`provideDebugConfigurations

provideDebugConfigurations(
debugType: string,
workspaceFolderUri: undefined | string,
): Promise<DebugConfiguration[]>
Parameters
- debugType: string
- workspaceFolderUri: undefined | string
Returns Promise<DebugConfiguration[]>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:483

provideDynamicDebugConfigurations

provideDynamicDebugConfigurations(): Promise<
Record<string, DynamicDebugConfigurationSessionOptions[]>,
>
Returns Promise<Record<string, DynamicDebugConfigurationSessionOptions[]>>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:508

provideDynamicDebugConfigurationsByType

provideDynamicDebugConfigurationsByType(
providerType: string,
): Promise<DynamicDebugConfigurationSessionOptions[]>
Provides dynamic debug configurations for a specific provider type only. This activates only the extension for the specified type, making it more efficient than provideDynamicDebugConfigurations() which activates all providers.
Parameters
- providerType: string
Returns Promise<DynamicDebugConfigurationSessionOptions[]>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:549

`Protected`resolveRecentDynamicOptionsFromData

resolveRecentDynamicOptionsFromData(
options?: DynamicDebugConfigurationSessionOptions[],
): void
Parameters
- Optionaloptions: DynamicDebugConfigurationSessionOptions[]
Returns void
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:617

save

save(): void
Returns void
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:630

`Protected`selectDebugType

selectDebugType(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:583

`Protected`selectRootUri

selectRootUri(): Promise<undefined | URI>
Returns Promise<undefined | URI>
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:406

`Protected`updateCurrent

updateCurrent(options?: undefined | DebugSessionOptions): void
Parameters
- options: undefined | DebugSessionOptions = ...
Returns void
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:251

`Protected`updateRecentlyUsedDynamicConfigurationOptions

updateRecentlyUsedDynamicConfigurationOptions(
option: undefined | DebugSessionOptions,
): void
Parameters
- option: undefined | DebugSessionOptions
Returns void
- Defined in packages/debug/src/browser/debug-configuration-manager.ts:224

Class DebugConfigurationManager

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DebugConfigurationManager

Properties

Protected_currentOptions

Protected ReadonlycontextKeyService

Protected Readonlydebug

ProtecteddebugConfigurationTypeKey

Protected ReadonlyeditorManager

Protectedinitialized

Protected ReadonlylabelProvider

Protected Readonlymodels

ReadonlyonDidChange

ReadonlyonDidChangeDynamicConfigurations

Protected ReadonlyonDidChangeDynamicConfigurationsEmitter

Protected ReadonlyonDidChangeEmitter

ReadonlyonWillProvideDebugConfiguration

Protected ReadonlyonWillProvideDebugConfigurationEmitter

Protected ReadonlyonWillProvideDynamicDebugConfigurationEmitter

Protected ReadonlypreferenceConfigurations

Protected Readonlypreferences

Protected ReadonlyquickPickService

ProtectedrecentDynamicOptionsTracker

Protected Readonlystorage

Protected ReadonlytextModelService

ProtectedupdateModels

Protected ReadonlyworkspaceService

Protected ReadonlyworkspaceVariables

Accessors

all

Returns IterableIterator<DebugSessionOptions>

current

Returns undefined | DebugSessionOptions

Parameters

Returns void

onDidChangeConfigurationProviders

Returns Event<void>

onWillProvideDynamicDebugConfiguration

Returns Event<WillProvideDebugConfiguration>

recentDynamicOptions

Returns readonly DynamicDebugConfigurationSessionOptions[]

supported

Returns Promise<IterableIterator<DebugSessionOptions, any, any>>

Methods

addConfiguration

Returns Promise<void>

ProtectedcompoundToOptions

Parameters

Returns DebugSessionOptions

ProtectedconfigurationToOptions

Parameters

Returns DebugSessionOptions

ProtecteddoCreate

Parameters

Returns Promise<URI>

ProtecteddoGetSupported

Parameters

Returns IterableIterator<DebugSessionOptions>

ProtecteddoInit

Returns Promise<void>

ProtecteddoOpen

Parameters

Returns Promise<EditorWidget>

ProtecteddynamicOptionsMatch

Parameters

Returns boolean

ProtectedensureContent

Parameters

Returns Promise<void>

fetchDynamicDebugConfiguration

Parameters

Returns Promise<undefined | DebugConfiguration>

find

Parameters

`Protected`_currentOptions

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`debug

`Protected`debugConfigurationTypeKey

`Protected` `Readonly`editorManager

`Protected`initialized

`Protected` `Readonly`labelProvider

`Protected` `Readonly`models

`Readonly`onDidChange

`Readonly`onDidChangeDynamicConfigurations

`Protected` `Readonly`onDidChangeDynamicConfigurationsEmitter

`Protected` `Readonly`onDidChangeEmitter

`Readonly`onWillProvideDebugConfiguration

`Protected` `Readonly`onWillProvideDebugConfigurationEmitter

`Protected` `Readonly`onWillProvideDynamicDebugConfigurationEmitter

`Protected` `Readonly`preferenceConfigurations

`Protected` `Readonly`preferences

`Protected` `Readonly`quickPickService

`Protected`recentDynamicOptionsTracker

`Protected` `Readonly`storage

`Protected` `Readonly`textModelService

`Protected`updateModels

`Protected` `Readonly`workspaceService

`Protected` `Readonly`workspaceVariables

`Protected`compoundToOptions

`Protected`configurationToOptions

`Protected`doCreate

`Protected`doGetSupported

`Protected`doInit

`Protected`doOpen

`Protected`dynamicOptionsMatch

`Protected`ensureContent

`Protected`fireWillProvideDebugConfiguration

`Protected`fireWillProvideDynamicDebugConfiguration

`Protected`getAll

`Protected`getInitialConfigurationContent

`Protected`getModel

`Protected`getSupported

`Protected`init

`Protected`provideDebugConfigurations

`Protected`resolveRecentDynamicOptionsFromData

`Protected`selectDebugType

`Protected`selectRootUri

`Protected`updateCurrent

`Protected`updateRecentlyUsedDynamicConfigurationOptions