Theia API Documentation v1.66.0
    Preparing search index...

    Class TheiaHeadlessPluginScanner

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    grammarsReader pluginUriFactory

    Accessors

    apiType

    Methods

    adaptContributesForHeadless adaptForHeadless adaptMetadataForHeadless getContribution getDependencies getEntryPoint getLicenseUrl getLifecycle getModel getPluginRootFileUrl getReadmeUrl readContributions

    Constructors

    Properties

    grammarsReader: GrammarsReader
    pluginUriFactory: PluginUriFactory

    Accessors

    • get apiType(): string

      The type of plugin's API (engine name)

      Returns string

    Methods

    • Adapt the given plugin's metadata for headless deployment, where it does not already natively specify its headless deployment, such as is the case for plugins declaring the "vscode" or "theiaPlugin" engine. This consists of cloning the relevant properties of its deployment metadata and modifying them as required, including but not limited to:

      • renaming the lifecycle start and stop functions as 'activate' and 'deactivate' following the VS Code naming convention (in case the plugin is a Theia-style plugin that uses 'start' and 'stop')
      • deleting inapplicable information such as frontend and backend init script paths
      • filtering/rewriting contributions and/or activation events

      The cloning is necessary to retain the original information for the non-headless deployments that the plugin also supports.

      Parameters

      Returns DeployedPlugin

    • A mapping between a dependency as its defined in package.json and its deployable form, e.g. publisher.name -> vscode:extension/publisher.name

      Parameters

      Returns undefined | Map<string, string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods