Class AbstractPluginScanner`Abstract`

This scanner process package.json object and returns plugin metadata objects.

Hierarchy (View Summary)

AbstractPluginScanner
- TheiaPluginScanner
- TheiaHeadlessPluginScanner

Implements

PluginScanner

Index

Constructors

Properties

grammarsReader pluginUriFactory

Accessors

Methods

getContribution getDependencies getEntryPoint getLicenseUrl getLifecycle getModel getPluginRootFileUrl getReadmeUrl readContributions

Constructors

constructor

new AbstractPluginScanner(
_apiType: string,
_backendInitPath?: string,
): AbstractPluginScanner
Parameters
- _apiType: string
- Optional_backendInitPath: string
Returns AbstractPluginScanner
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:150

Properties

`Protected` `Readonly`grammarsReader

grammarsReader: GrammarsReader

`Protected` `Readonly`pluginUriFactory

pluginUriFactory: PluginUriFactory

Accessors

apiType

get apiType(): string
The type of plugin's API (engine name)

Returns string
Implementation of PluginScanner.apiType
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:155

Methods

getContribution

getContribution(
rawPlugin: PluginPackage,
): Promise<undefined | PluginContribution>
Parameters
- rawPlugin: PluginPackage
Returns Promise<undefined | PluginContribution>
Implementation of PluginScanner.getContribution
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:226

getDependencies

getDependencies(rawPlugin: PluginPackage): undefined | Map<string, string>
A mapping between a dependency as its defined in package.json and its deployable form, e.g. publisher.name -> vscode:extension/publisher.name
Parameters
- rawPlugin: PluginPackage
Returns undefined | Map<string, string>
Implementation of PluginScanner.getDependencies
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:221

`Protected` `Abstract`getEntryPoint

getEntryPoint(plugin: PluginPackage): PluginEntryPoint
Parameters
- plugin: PluginPackage
Returns PluginEntryPoint
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:205

`Protected`getLicenseUrl

getLicenseUrl(plugin: PluginPackage): undefined | string
Parameters
- plugin: PluginPackage
Returns undefined | string
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:187

getLifecycle

getLifecycle(plugin: PluginPackage): PluginLifecycle
Creates plugin's lifecycle.
Parameters
- plugin: PluginPackage
Returns PluginLifecycle
Implementation of PluginScanner.getLifecycle
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:207

getModel

getModel(plugin: PluginPackage): PluginModel
Creates plugin's model.
Parameters
- plugin: PluginPackage
Returns PluginModel
Implementation of PluginScanner.getModel
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:159

`Protected`getPluginRootFileUrl

getPluginRootFileUrl(plugin: PluginPackage, names: string[]): undefined | string
Parameters
- plugin: PluginPackage
- names: string[]
Returns undefined | string
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:191

`Protected`getReadmeUrl

getReadmeUrl(plugin: PluginPackage): undefined | string
Parameters
- plugin: PluginPackage
Returns undefined | string
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:183

`Protected`readContributions

readContributions(
rawPlugin: PluginPackageWithContributes,
contributions: PluginContribution,
): Promise<PluginContribution>
Parameters
- rawPlugin: PluginPackageWithContributes
- contributions: PluginContribution
Returns Promise<PluginContribution>
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:242