Class PreferenceCliContribution

Call back for extension to contribute options to the cli.

Implements

Index

Constructors

Properties

preferences sessionPreferences

Methods

configure enhanceArgs getPreferences getSessionPreferences parseInto setArguments

Constructors

constructor

new PreferenceCliContribution(): PreferenceCliContribution
Returns PreferenceCliContribution

Properties

`Protected`preferences

preferences: [string, unknown][] = []

`Protected`sessionPreferences

sessionPreferences: [string, unknown][] = []

Methods

configure

configure(conf: Argv<{}>): void
Parameters
- conf: Argv<{}>
Returns void
Implementation of CliContribution.configure
- Defined in packages/preferences/src/node/preference-cli-contribution.ts:29

enhanceArgs

enhanceArgs(_context: RemoteCliContext): string[]
Forward --session-preference values to the remote backend when attaching to a remote (e.g. dev container). Values are base64-encoded JSON to survive shell argument parsing intact.
Parameters
- _context: RemoteCliContext
Returns string[]
Implementation of RemoteCliContribution.enhanceArgs
- Defined in packages/preferences/src/node/preference-cli-contribution.ts:83

getPreferences

getPreferences(): Promise<[string, unknown][]>
Returns Promise<[string, unknown][]>
Implementation of CliPreferences.getPreferences
- Defined in packages/preferences/src/node/preference-cli-contribution.ts:70

getSessionPreferences

getSessionPreferences(): Promise<[string, unknown][]>
Returns Promise<[string, unknown][]>
Implementation of CliPreferences.getSessionPreferences
- Defined in packages/preferences/src/node/preference-cli-contribution.ts:74

`Protected`parseInto

parseInto(raw: unknown, target: [string, unknown][]): void
Parameters
- raw: unknown
- target: [string, unknown][]
Returns void
- Defined in packages/preferences/src/node/preference-cli-contribution.ts:49

setArguments

setArguments(args: Record<string, unknown>): void
Parameters
- args: Record<string, unknown>
Returns void
Implementation of CliContribution.setArguments
- Defined in packages/preferences/src/node/preference-cli-contribution.ts:40