Interface PluginScanner

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

interface PluginScanner {
    apiType: string;
    getContribution(
        plugin: PluginPackage,
    ): Promise<undefined | PluginContribution>;
    getDependencies(plugin: PluginPackage): undefined | Map<string, string>;
    getLifecycle(plugin: PluginPackage): PluginLifecycle;
    getModel(plugin: PluginPackage): PluginModel;
}

Implemented by

AbstractPluginScanner

Index

Properties

Methods

getContribution getDependencies getLifecycle getModel

Properties

apiType

apiType: string

The type of plugin's API (engine name)

Methods

getContribution

getContribution(plugin: PluginPackage): Promise<undefined | PluginContribution>
Parameters
- plugin: PluginPackage
Returns Promise<undefined | PluginContribution>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:386

getDependencies

getDependencies(plugin: 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
- plugin: PluginPackage
Returns undefined | Map<string, string>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:392

getLifecycle

getLifecycle(plugin: PluginPackage): PluginLifecycle
Creates plugin's lifecycle.
Parameters
- plugin: PluginPackage
Returns PluginLifecycle
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:384

getModel

getModel(plugin: PluginPackage): PluginModel
Creates plugin's model.
Parameters
- plugin: PluginPackage
Returns PluginModel
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:377