Class TheiaPluginScanner

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

Hierarchy (view full)

AbstractPluginScanner
- TheiaPluginScanner
  - TheiaPluginScannerElectron

Constructors

constructor

new TheiaPluginScanner(): TheiaPluginScanner
Returns TheiaPluginScanner
Overrides AbstractPluginScanner.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 AbstractPluginScanner.apiType
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:108

Methods

`Private` extractPluginViewsIds

extractPluginViewsIds(views): string[]
Parameters
- views: undefined | {
  [location: string]: PluginPackageView[];
  }
Returns string[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:744

`Private` extractValidAutoClosingPairs

extractValidAutoClosingPairs(langId, configuration): undefined | AutoClosingPairConditional[]
Parameters
- langId: string
- configuration: PluginPackageLanguageContributionConfiguration
Returns undefined | AutoClosingPairConditional[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:874

`Private` extractValidSurroundingPairs

extractValidSurroundingPairs(langId, configuration): undefined | AutoClosingPair[]
Parameters
- langId: string
- configuration: PluginPackageLanguageContributionConfiguration
Returns undefined | AutoClosingPair[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:920

getContribution

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

`Protected` getEntryPoint

getEntryPoint(plugin): PluginEntryPoint
Parameters
- plugin: PluginPackage
Returns PluginEntryPoint
Overrides AbstractPluginScanner.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 AbstractPluginScanner.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
Inherited from AbstractPluginScanner.getModel
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:112

`Protected` readColors

readColors(pck): undefined | ColorDefinition[]
Parameters
- pck: PluginPackage
Returns undefined | ColorDefinition[]
- 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
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:473

`Private` readConfiguration

readConfiguration(rawConfiguration, pluginPath): undefined | PreferenceSchema
Parameters
- rawConfiguration: RecursivePartial<PreferenceSchema>
- pluginPath: string
Returns undefined | PreferenceSchema
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:668

`Protected` readContributions

readContributions(rawPlugin, contributions): 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:194

`Private` readCustomEditor

readCustomEditor(rawCustomEditor): CustomEditor
Parameters
- rawCustomEditor: PluginPackageCustomEditor
Returns CustomEditor
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:688

`Private` readCustomEditors

readCustomEditors(rawCustomEditors): CustomEditor[]
Parameters
- rawCustomEditors: PluginPackageCustomEditor[]
Returns CustomEditor[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:684

`Private` readDebugger

readDebugger(rawDebugger): DebuggerContribution
Parameters
- rawDebugger: PluginPackageDebuggersContribution
Returns DebuggerContribution
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:825

`Private` readDebuggers

readDebuggers(rawDebuggers): DebuggerContribution[]
Parameters
- rawDebuggers: PluginPackageDebuggersContribution[]
Returns DebuggerContribution[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:821

`Protected` readFile

readFile(filePath): Promise<string>
Parameters
- filePath: string
Returns Promise<string>
- 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[]
- 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[]
- 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>
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:651

`Private` readKeybinding

readKeybinding(rawKeybinding): Keybinding
Parameters
- rawKeybinding: PluginPackageKeybinding
Returns Keybinding
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:672

`Private` readLanguage

readLanguage(rawLang, plugin): Promise<LanguageContribution>
Parameters
- rawLang: PluginPackageLanguageContribution
- plugin: PluginPackage
Returns Promise<LanguageContribution>
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:788

`Private` readLanguages

readLanguages(rawLanguages, plugin): Promise<LanguageContribution[]>
Parameters
- rawLanguages: PluginPackageLanguageContribution[]
- plugin: PluginPackage
Returns Promise<LanguageContribution[]>
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:770

`Protected` readLocalization

readLocalization(__namedParameters, pluginPath): Localization
Parameters
- __namedParameters: PluginPackageLocalization
- pluginPath: string
Returns Localization
- 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[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:447

`Private` readMenu

readMenu(rawMenu): Menu
Parameters
- rawMenu: PluginPackageMenu
Returns Menu
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:759

`Private` readMenus

readMenus(rawMenus): Menu[]
Parameters
- rawMenus: PluginPackageMenu[]
Returns Menu[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:755

`Protected` readSnippets

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

`Private` readSubmenu

readSubmenu(rawSubmenu, plugin): Submenu
Parameters
- rawSubmenu: PluginPackageSubmenu
- plugin: PluginPackage
Returns Submenu
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:778

`Private` readSubmenus

readSubmenus(rawSubmenus, plugin): Submenu[]
Parameters
- rawSubmenus: PluginPackageSubmenu[]
- plugin: PluginPackage
Returns Submenu[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:774

`Private` readTaskDefinition

readTaskDefinition(pluginName, definitionContribution): TaskDefinition
Parameters
- pluginName: string
- definitionContribution: PluginTaskDefinitionContribution
Returns TaskDefinition
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:849

`Protected` readTerminals

readTerminals(pck): undefined | TerminalProfile[]
Parameters
- pck: PluginPackage
Returns undefined | TerminalProfile[]
- 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[]
- 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
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:465

`Private` readView

readView(rawView): View
Parameters
- rawView: PluginPackageView
Returns View
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:716

`Private` readViewContainer

readViewContainer(rawViewContainer, pck): ViewContainer
Parameters
- rawViewContainer: PluginPackageViewContainer
- pck: PluginPackage
Returns ViewContainer
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:701

`Private` readViewWelcome

readViewWelcome(rawViewWelcome, pluginViewsIds): ViewWelcome
Parameters
- rawViewWelcome: PluginPackageViewWelcome
- pluginViewsIds: string[]
Returns ViewWelcome
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:731

`Private` readViews

readViews(rawViews): View[]
Parameters
- rawViews: PluginPackageView[]
Returns View[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:712

`Private` readViewsContainers

readViewsContainers(rawViewsContainers, pck): ViewContainer[]
Parameters
- rawViewsContainers: PluginPackageViewContainer[]
- pck: PluginPackage
Returns ViewContainer[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:697

`Private` readViewsWelcome

readViewsWelcome(rawViewsWelcome, rowViews): ViewWelcome[]
Parameters
- rawViewsWelcome: PluginPackageViewWelcome[]
- rowViews: undefined | {
  [location: string]: PluginPackageView[];
  }
Returns ViewWelcome[]
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:727

`Protected` toPluginUrl

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

`Protected` toSchema

toSchema(definition): IJSONSchema
Parameters
- definition: PluginTaskDefinitionContribution
Returns IJSONSchema
- 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;
}
- Defined in packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts:478