Class VsCodePluginScanner

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

Hierarchy (View Summary)

TheiaPluginScanner
- VsCodePluginScanner

Implements

PluginScanner

Constructors

constructor

new VsCodePluginScanner(): VsCodePluginScanner
Returns VsCodePluginScanner
Inherited from TheiaPluginScanner.constructor
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:64

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
Overrides TheiaPluginScanner.apiType
- Defined in packages/plugin-ext-vscode/src/node/scanner-vscode.ts:31

Methods

getContribution

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

getDependencies

getDependencies(plugin: PluginPackage): undefined | Map<string, string>
Maps extension dependencies to deployable extension dependencies.
Parameters
- plugin: PluginPackage
Returns undefined | Map<string, string>
Implementation of PluginScanner.getDependencies
Overrides TheiaPluginScanner.getDependencies
- Defined in packages/plugin-ext-vscode/src/node/scanner-vscode.ts:85

`Protected`getEntryPoint

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

`Protected`getLicenseUrl

getLicenseUrl(plugin: PluginPackage): undefined | string
Parameters
- plugin: PluginPackage
Returns undefined | string
Inherited from TheiaPluginScanner.getLicenseUrl
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:55

getLifecycle

getLifecycle(plugin: PluginPackage): PluginLifecycle
Creates plugin's lifecycle.
Parameters
- plugin: PluginPackage
Returns PluginLifecycle
Implementation of PluginScanner.getLifecycle
Overrides TheiaPluginScanner.getLifecycle
- Defined in packages/plugin-ext-vscode/src/node/scanner-vscode.ts:102

getModel

getModel(plugin: PluginPackage): PluginModel
Creates plugin's model.
Parameters
- plugin: PluginPackage
Returns PluginModel
Implementation of PluginScanner.getModel
Overrides TheiaPluginScanner.getModel
- Defined in packages/plugin-ext-vscode/src/node/scanner-vscode.ts:35

`Protected`getPluginRootFileUrl

getPluginRootFileUrl(plugin: PluginPackage, names: string[]): undefined | string
Parameters
- plugin: PluginPackage
- names: string[]
Returns undefined | string
Inherited from TheiaPluginScanner.getPluginRootFileUrl
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:56

`Protected`getReadmeUrl

getReadmeUrl(plugin: PluginPackage): undefined | string
Parameters
- plugin: PluginPackage
Returns undefined | string
Inherited from TheiaPluginScanner.getReadmeUrl
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:54

`Protected`readColors

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

`Protected`readCommand

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

`Protected`readContributions

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

`Protected`readFile

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

`Protected`readIcons

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

`Protected`readIconThemes

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

`Protected`readJson

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

`Protected`readLocalization

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

`Protected`readLocalizations

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

`Protected`readSnippets

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

`Protected`readTerminals

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

`Protected`readThemes

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

`Protected`readTranslation

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

`Protected`toPluginUrl

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

`Protected`toSchema

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

`Protected`transformIconUrl

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

`Static`getScope

getScope(
monacoScope: undefined | string,
): { overridable: boolean; scope: undefined | PreferenceScope }
Parameters
- monacoScope: undefined | string
Returns { overridable: boolean; scope: undefined | PreferenceScope }
Inherited from TheiaPluginScanner.getScope
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:66