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:30

Properties

`Protected` `Readonly`grammarsReader

grammarsReader: GrammarsReader

`Protected` `Readonly`logger

logger: ILogger

`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:32

Methods

`Protected`applyTrustExtraction

applyTrustExtraction(plugin: PluginPackage, result: PluginModel): void
Parameters
- plugin: PluginPackage
- result: PluginModel
Returns void
Inherited from TheiaPluginScanner.applyTrustExtraction
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:19

`Protected`contributionCtx

contributionCtx(
pck: PluginPackage,
): NormalizeContributionsContext<PluginPackage>
Parameters
- pck: PluginPackage
Returns NormalizeContributionsContext<PluginPackage>
Inherited from TheiaPluginScanner.contributionCtx
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:38

`Protected`extractPluginViewsIds

extractPluginViewsIds(
views: undefined | { [location: string]: readonly PluginPackageView[] },
): string[]
Parameters
- views: undefined | { [location: string]: readonly PluginPackageView[] }
Returns string[]
Inherited from TheiaPluginScanner.extractPluginViewsIds
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:67

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:26

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:51

`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:32

`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:21

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:64

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:36

`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:22

`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:20

`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:50

`Protected`readCommand

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

`Protected`readConfiguration

readConfiguration(
rawConfiguration: IConfigurationNode,
pluginPath: string,
): undefined | PreferenceSchema
Parameters
- rawConfiguration: IConfigurationNode
- pluginPath: string
Returns undefined | PreferenceSchema
Inherited from TheiaPluginScanner.readConfiguration
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:55

`Protected`readContributions

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

`Protected`readCustomEditor

readCustomEditor(
rawCustomEditor: PluginPackageCustomEditor,
): NormalizedCustomEditor
Parameters
- rawCustomEditor: PluginPackageCustomEditor
Returns NormalizedCustomEditor
Inherited from TheiaPluginScanner.readCustomEditor
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:58

`Protected`readCustomEditors

readCustomEditors(
rawCustomEditors: PluginPackageCustomEditor[],
): NormalizedCustomEditor[]
Parameters
- rawCustomEditors: PluginPackageCustomEditor[]
Returns NormalizedCustomEditor[]
Inherited from TheiaPluginScanner.readCustomEditors
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:57

`Protected`readDebugger

readDebugger(
rawDebugger: PluginPackageDebuggersContribution,
): PluginPackageDebuggersContribution
Parameters
- rawDebugger: PluginPackageDebuggersContribution
Returns PluginPackageDebuggersContribution
Inherited from TheiaPluginScanner.readDebugger
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:77

`Protected`readDebuggers

readDebuggers(
rawDebuggers: PluginPackageDebuggersContribution[],
): PluginPackageDebuggersContribution[]
Parameters
- rawDebuggers: PluginPackageDebuggersContribution[]
Returns PluginPackageDebuggersContribution[]
Inherited from TheiaPluginScanner.readDebuggers
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:76

`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:81

`Protected`readIcons

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

`Protected`readIconThemes

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

`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:80

`Protected`readKeybinding

readKeybinding(rawKeybinding: PluginPackageKeybinding): NormalizedKeybinding
Parameters
- rawKeybinding: PluginPackageKeybinding
Returns NormalizedKeybinding
Inherited from TheiaPluginScanner.readKeybinding
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:56

`Protected`readLanguage

readLanguage(
rawLang: PluginPackageLanguageContribution,
plugin: PluginPackage,
): Promise<NormalizedLanguage>
Parameters
- rawLang: PluginPackageLanguageContribution
- plugin: PluginPackage
Returns Promise<NormalizedLanguage>
Inherited from TheiaPluginScanner.readLanguage
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:75

`Protected`readLanguages

readLanguages(
rawLanguages: readonly PluginPackageLanguageContribution[],
plugin: PluginPackage,
): Promise<NormalizedLanguage[]>
Parameters
- rawLanguages: readonly PluginPackageLanguageContribution[]
- plugin: PluginPackage
Returns Promise<NormalizedLanguage[]>
Inherited from TheiaPluginScanner.readLanguages
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:72

`Protected`readLocalization

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

`Protected`readLocalizations

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

`Protected`readMenu

readMenu(rawMenu: PluginPackageMenu): PluginPackageMenu
Parameters
- rawMenu: PluginPackageMenu
Returns PluginPackageMenu
Inherited from TheiaPluginScanner.readMenu
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:71

`Protected`readMenus

readMenus(rawMenus: readonly PluginPackageMenu[]): PluginPackageMenu[]
Parameters
- rawMenus: readonly PluginPackageMenu[]
Returns PluginPackageMenu[]
Inherited from TheiaPluginScanner.readMenus
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:70

`Protected`readSnippets

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

`Protected`readSubmenu

readSubmenu(
rawSubmenu: PluginPackageSubmenu,
plugin: PluginPackage,
): NormalizedSubmenu
Parameters
- rawSubmenu: PluginPackageSubmenu
- plugin: PluginPackage
Returns NormalizedSubmenu
Inherited from TheiaPluginScanner.readSubmenu
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:74

`Protected`readSubmenus

readSubmenus(
rawSubmenus: readonly PluginPackageSubmenu[],
plugin: PluginPackage,
): NormalizedSubmenu[]
Parameters
- rawSubmenus: readonly PluginPackageSubmenu[]
- plugin: PluginPackage
Returns NormalizedSubmenu[]
Inherited from TheiaPluginScanner.readSubmenus
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:73

`Protected`readTaskDefinition

readTaskDefinition(
pluginName: string,
definitionContribution: PluginTaskDefinitionContribution,
): TaskDefinition
Parameters
- pluginName: string
- definitionContribution: PluginTaskDefinitionContribution
Returns TaskDefinition
Inherited from TheiaPluginScanner.readTaskDefinition
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:78

`Protected`readTerminals

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

`Protected`readThemes

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

`Protected`readTranslation

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

`Protected`readView

readView(rawView: PluginPackageView): PluginPackageView
Parameters
- rawView: PluginPackageView
Returns PluginPackageView
Inherited from TheiaPluginScanner.readView
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:62

`Protected`readViewContainer

readViewContainer(
rawViewContainer: PluginPackageViewContainer,
pck: PluginPackage,
): undefined | NormalizedViewContainer
Parameters
- rawViewContainer: PluginPackageViewContainer
- pck: PluginPackage
Returns undefined | NormalizedViewContainer
Inherited from TheiaPluginScanner.readViewContainer
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:60

`Protected`readViews

readViews(rawViews: PluginPackageView[]): PluginPackageView[]
Parameters
- rawViews: PluginPackageView[]
Returns PluginPackageView[]
Inherited from TheiaPluginScanner.readViews
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:61

`Protected`readViewsContainers

readViewsContainers(
rawViewsContainers: readonly PluginPackageViewContainer[],
pck: PluginPackage,
): NormalizedViewContainer[]
Parameters
- rawViewsContainers: readonly PluginPackageViewContainer[]
- pck: PluginPackage
Returns NormalizedViewContainer[]
Inherited from TheiaPluginScanner.readViewsContainers
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:59

`Protected`readViewsWelcome

readViewsWelcome(
rawViewsWelcome: readonly PluginPackageViewWelcome[],
rowViews: undefined | { [location: string]: readonly PluginPackageView[] },
): NormalizedViewWelcome[]
Parameters
- rawViewsWelcome: readonly PluginPackageViewWelcome[]
- rowViews: undefined | { [location: string]: readonly PluginPackageView[] }
Returns NormalizedViewWelcome[]
Inherited from TheiaPluginScanner.readViewsWelcome
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:63

`Protected`readViewWelcome

readViewWelcome(
rawViewWelcome: PluginPackageViewWelcome,
pluginViewsIds: string[],
): NormalizedViewWelcome
Parameters
- rawViewWelcome: PluginPackageViewWelcome
- pluginViewsIds: string[]
Returns NormalizedViewWelcome
Inherited from TheiaPluginScanner.readViewWelcome
- Defined in packages/plugin-ext/lib/hosted/node/scanners/scanner-theia.d.ts:66

`Protected`readWalkthroughs

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

`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:49

`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:79

`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:45

`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:33

Class VsCodePluginScanner

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns VsCodePluginScanner

Properties

Protected ReadonlygrammarsReader

Protected Readonlylogger

Protected ReadonlypluginUriFactory

Accessors

apiType

Returns string

Methods

ProtectedapplyTrustExtraction

Parameters

Returns void

ProtectedcontributionCtx

Parameters

Returns NormalizeContributionsContext<PluginPackage>

ProtectedextractPluginViewsIds

Parameters

Returns string[]

getContribution

Parameters

Returns Promise<undefined | PluginContribution>

getDependencies

Parameters

Returns undefined | Map<string, string>

ProtectedgetEntryPoint

Parameters

Returns PluginEntryPoint

ProtectedgetLicenseUrl

Parameters

Returns undefined | string

getLifecycle

Parameters

Returns PluginLifecycle

getModel

Parameters

Returns PluginModel

ProtectedgetPluginRootFileUrl

Parameters

Returns undefined | string

ProtectedgetReadmeUrl

Parameters

Returns undefined | string

ProtectedreadColors

Parameters

Returns undefined | ColorDefinition[]

ProtectedreadCommand

Parameters

Returns NormalizedCommand

ProtectedreadConfiguration

Parameters

Returns undefined | PreferenceSchema

ProtectedreadContributions

Parameters

Returns Promise<PluginContribution>

ProtectedreadCustomEditor

Parameters

Returns NormalizedCustomEditor

ProtectedreadCustomEditors

Parameters

Returns NormalizedCustomEditor[]

ProtectedreadDebugger

Parameters

Returns PluginPackageDebuggersContribution

ProtectedreadDebuggers

Parameters

Returns PluginPackageDebuggersContribution[]

ProtectedreadFile

Parameters

Returns Promise<string>

ProtectedreadIcons

`Protected` `Readonly`grammarsReader

`Protected` `Readonly`logger

`Protected` `Readonly`pluginUriFactory

`Protected`applyTrustExtraction

`Protected`contributionCtx

`Protected`extractPluginViewsIds

`Protected`getEntryPoint

`Protected`getLicenseUrl

`Protected`getPluginRootFileUrl

`Protected`getReadmeUrl

`Protected`readColors

`Protected`readCommand

`Protected`readConfiguration

`Protected`readContributions

`Protected`readCustomEditor

`Protected`readCustomEditors

`Protected`readDebugger

`Protected`readDebuggers

`Protected`readFile

`Protected`readIcons

`Protected`readIconThemes

`Protected`readJson

`Protected`readKeybinding

`Protected`readLanguage

`Protected`readLanguages

`Protected`readLocalization

`Protected`readLocalizations

`Protected`readMenu

`Protected`readMenus

`Protected`readSnippets

`Protected`readSubmenu

`Protected`readSubmenus

`Protected`readTaskDefinition

`Protected`readTerminals

`Protected`readThemes

`Protected`readTranslation

`Protected`readView

`Protected`readViewContainer

`Protected`readViews

`Protected`readViewsContainers

`Protected`readViewsWelcome

`Protected`readViewWelcome

`Protected`readWalkthroughs