Class TheiaPluginScannerElectron

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

Hierarchy (view full)

TheiaPluginScanner
- TheiaPluginScannerElectron

Constructors

constructor

new TheiaPluginScannerElectron(): TheiaPluginScannerElectron
Returns TheiaPluginScannerElectron
Inherited from TheiaPluginScanner.constructor
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:179

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
Inherited from TheiaPluginScanner.apiType
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:108

Methods

getContribution

getContribution(rawPlugin): Promise<undefined | PluginContribution>
Parameters
- rawPlugin: PluginPackage
Returns Promise<undefined | PluginContribution>
Inherited from TheiaPluginScanner.getContribution
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:155

getDependencies

getDependencies(rawPlugin): 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>
Inherited from TheiaPluginScanner.getDependencies
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:150

`Protected` getEntryPoint

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

getLifecycle

getLifecycle(plugin): PluginLifecycle
Creates plugin's lifecycle.
Parameters
- plugin: PluginPackage
Returns PluginLifecycle
Inherited from TheiaPluginScanner.getLifecycle
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:136

getModel

getModel(plugin): PluginModel
Creates plugin's model.
Parameters
- plugin: PluginPackage
Returns PluginModel
Overrides TheiaPluginScanner.getModel
- Defined in packages/plugin-ext/src/hosted/node-electron/scanner-theia-electron.ts:24

`Protected` readColors

readColors(pck): undefined | ColorDefinition[]
Parameters
- pck: PluginPackage
Returns undefined | ColorDefinition[]
Inherited from TheiaPluginScanner.readColors
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:501

`Protected` readCommand

readCommand(__namedParameters, pck): PluginCommand
Parameters
- __namedParameters: PluginPackageCommand
- pck: PluginPackage
Returns PluginCommand
Inherited from TheiaPluginScanner.readCommand
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:473

`Protected` readContributions

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

`Protected` readFile

readFile(filePath): Promise<string>
Parameters
- filePath: string
Returns Promise<string>
Inherited from TheiaPluginScanner.readFile
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:655

`Protected` readIconThemes

readIconThemes(pck): undefined | IconThemeContribution[]
Parameters
- pck: PluginPackage
Returns undefined | IconThemeContribution[]
Inherited from TheiaPluginScanner.readIconThemes
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:556

`Protected` readIcons

readIcons(pck): undefined | IconContribution[]
Parameters
- pck: PluginPackage
Returns undefined | IconContribution[]
Inherited from TheiaPluginScanner.readIcons
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:581

`Protected` readJson

readJson<T>(filePath): Promise<undefined | T>
Type Parameters
- T
Parameters
- filePath: string
Returns Promise<undefined | T>
Inherited from TheiaPluginScanner.readJson
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:651

`Protected` readLocalization

readLocalization(__namedParameters, pluginPath): Localization
Parameters
- __namedParameters: PluginPackageLocalization
- pluginPath: string
Returns Localization
Inherited from TheiaPluginScanner.readLocalization
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:454

`Protected` readLocalizations

readLocalizations(pck): undefined | Localization[]
Parameters
- pck: PluginPackage
Returns undefined | Localization[]
Inherited from TheiaPluginScanner.readLocalizations
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:447

`Protected` readSnippets

readSnippets(pck): undefined | SnippetContribution[]
Parameters
- pck: PluginPackage
Returns undefined | SnippetContribution[]
Inherited from TheiaPluginScanner.readSnippets
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:634

`Protected` readTerminals

readTerminals(pck): undefined | TerminalProfile[]
Parameters
- pck: PluginPackage
Returns undefined | TerminalProfile[]
Inherited from TheiaPluginScanner.readTerminals
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:440

`Protected` readThemes

readThemes(pck): undefined | ThemeContribution[]
Parameters
- pck: PluginPackage
Returns undefined | ThemeContribution[]
Inherited from TheiaPluginScanner.readThemes
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:537

`Protected` readTranslation

readTranslation(packageTranslation, pluginPath): Translation
Parameters
- packageTranslation: PluginPackageTranslation
- pluginPath: string
Returns Translation
Inherited from TheiaPluginScanner.readTranslation
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:465

`Protected` toPluginUrl

toPluginUrl(pck, relativePath): string
Parameters
- pck: PluginPackage
- relativePath: string
Returns string
Inherited from TheiaPluginScanner.toPluginUrl
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:497

`Protected` toSchema

toSchema(definition): IJSONSchema
Parameters
- definition: PluginTaskDefinitionContribution
Returns IJSONSchema
Inherited from TheiaPluginScanner.toSchema
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:863

`Protected` transformIconUrl

transformIconUrl(plugin, original?): undefined | {
iconUrl?: IconUrl;
themeIcon?: string;
}
Parameters
- plugin: PluginPackage
- Optional original: IconUrl
Returns undefined | {
iconUrl?: IconUrl;
themeIcon?: string;
}
Inherited from TheiaPluginScanner.transformIconUrl
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:478