Class TheiaPluginScanner

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

Hierarchy (View Summary)

AbstractPluginScanner
- TheiaPluginScanner
  - TheiaPluginScannerElectron
  - VsCodePluginScanner

Constructors

constructor

new TheiaPluginScanner(): TheiaPluginScanner
Returns TheiaPluginScanner
Overrides AbstractPluginScanner.constructor
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:250

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

`Protected`getEntryPoint

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

`Protected`getLicenseUrl

getLicenseUrl(plugin: PluginPackage): undefined | string
Parameters
- plugin: PluginPackage
Returns undefined | string
Inherited from AbstractPluginScanner.getLicenseUrl
- 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
Inherited from AbstractPluginScanner.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
Inherited from AbstractPluginScanner.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
Inherited from AbstractPluginScanner.getPluginRootFileUrl
- 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
Inherited from AbstractPluginScanner.getReadmeUrl
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:183

`Protected`readColors

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

`Protected`readCommand

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

`Protected`readContributions

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

`Protected`readFile

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

`Protected`readIcons

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

`Protected`readIconThemes

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

`Protected`readJson

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

`Protected`readLocalization

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

`Protected`readLocalizations

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

`Protected`readSnippets

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

`Protected`readTerminals

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

`Protected`readThemes

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

`Protected`readTranslation

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

`Protected`toPluginUrl

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

`Protected`toSchema

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

`Protected`transformIconUrl

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

`Static`getScope

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