Class PluginCliContribution

Call back for extension to contribute options to the cli.

Implements

CliContribution

Index

Constructors

Properties

_keepUncompressedInPlace _localDir _maxSessionLogsFolders DEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS PLUGIN_MAX_SESSION_LOGS_FOLDERS PLUGINS UNCOMPRESSED_PLUGINS_IN_PLACE

Methods

configure copyUncompressedPlugins localDir maxSessionLogsFolders setArguments

Constructors

constructor

new PluginCliContribution(): PluginCliContribution
Returns PluginCliContribution

Properties

`Protected`_keepUncompressedInPlace

_keepUncompressedInPlace: boolean = false

`Protected`_localDir

_localDir: undefined | string

`Protected`_maxSessionLogsFolders

_maxSessionLogsFolders: number

`Static`DEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS

DEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS: number = PluginPaths.DEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS

Shared with the browser-only frontend (which has no CLI to read this option from) via PluginPaths.DEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS, so the two defaults cannot drift apart.

`Static`PLUGIN_MAX_SESSION_LOGS_FOLDERS

PLUGIN_MAX_SESSION_LOGS_FOLDERS: string = 'plugin-max-session-logs-folders'

`Static`PLUGINS

PLUGINS: string = 'plugins'

`Static`UNCOMPRESSED_PLUGINS_IN_PLACE

UNCOMPRESSED_PLUGINS_IN_PLACE: string = 'uncompressed-plugins-in-place'

Methods

configure

configure(conf: Argv): void
Parameters
- conf: Argv
Returns void
Implementation of CliContribution.configure
- Defined in packages/plugin-ext/src/main/node/plugin-cli-contribution.ts:39

copyUncompressedPlugins

copyUncompressedPlugins(): boolean
Returns boolean
- Defined in packages/plugin-ext/src/main/node/plugin-cli-contribution.ts:83

localDir

localDir(): undefined | string
Returns undefined | string
- Defined in packages/plugin-ext/src/main/node/plugin-cli-contribution.ts:75

maxSessionLogsFolders

maxSessionLogsFolders(): number
Returns number
- Defined in packages/plugin-ext/src/main/node/plugin-cli-contribution.ts:79

setArguments

setArguments(
args: { _: (string | number)[]; $0: string; [argName: string]: unknown },
): void
Parameters
- args: { _: (string | number)[]; $0: string; [argName: string]: unknown }
  - [argName: string]: unknown
    All remaining options
  - _: (string | number)[]
    Non-option arguments
  - $0: string
    The script name or node command
Returns void
Implementation of CliContribution.setArguments
- Defined in packages/plugin-ext/src/main/node/plugin-cli-contribution.ts:62

Class PluginCliContribution

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PluginCliContribution

Properties

`Protected`_keepUncompressedInPlace

`Protected`_localDir

`Protected`_maxSessionLogsFolders

`Static`DEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS

`Static`PLUGIN_MAX_SESSION_LOGS_FOLDERS

`Static`PLUGINS

`Static`UNCOMPRESSED_PLUGINS_IN_PLACE

Methods

configure

Parameters

Returns void

copyUncompressedPlugins

Returns boolean

localDir

Returns undefined | string

maxSessionLogsFolders

Returns number

setArguments

Parameters

[argName: string]: unknown

_: (string | number)[]

$0: string

Returns void

Settings

On This Page

Class PluginCliContribution

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PluginCliContribution

Properties

Protected_keepUncompressedInPlace

Protected_localDir

Protected_maxSessionLogsFolders

StaticDEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS

StaticPLUGIN_MAX_SESSION_LOGS_FOLDERS

StaticPLUGINS

StaticUNCOMPRESSED_PLUGINS_IN_PLACE

Methods

configure

Parameters

Returns void

copyUncompressedPlugins

Returns boolean

localDir

Returns undefined | string

maxSessionLogsFolders

Returns number

setArguments

Parameters

[argName: string]: unknown

_: (string | number)[]

$0: string

Returns void

Settings

On This Page

`Protected`_keepUncompressedInPlace

`Protected`_localDir

`Protected`_maxSessionLogsFolders

`Static`DEFAULT_PLUGIN_MAX_SESSION_LOGS_FOLDERS

`Static`PLUGIN_MAX_SESSION_LOGS_FOLDERS

`Static`PLUGINS

`Static`UNCOMPRESSED_PLUGINS_IN_PLACE