使用Theia——创建插件

  • 时间:
  • 浏览:1

上一篇:使用Theia——创建扩展包

创建Theia插件

  下面大伙儿来看看要怎样创建Theia插件。作为示例,大伙儿将注册有另另十个 Hello World命令,该命令显示有另另十个 “Hello World”通知。本文将指导你完成所有必要的步骤。

Theia的架构

插件与扩展包

  Theia是有另另十个 可扩展的IDE。你可能性听说过扩展是定制IDE的三种措施,而插件则是三种都都都上能 被加带到Theia中的新的可扩展模型。下面是什么都有关插件和扩展包之间的主要区别。

插件

  优点:

  • 代码隔离:插件的代码运行在独立的程序中,它不必阻塞Theia核心程序。

  • 都都都上能 在运行时加载。不时需重新编译整个Theia IDE。

  • 减少编译时间。

  • 自涵盖。插件都都都上能 被打包成有另另十个 独立的文件,并在稍后直接加载。它不时需从npmjs可能性其它的地方获取额外的依赖项。

  • 简单的API

  • 不时需学习inversify或任何其它的框架。

  • 单个入口,涵盖代码补全,以查看可能性的与JsDoc相关的调用。

  • 可能性API是向后兼容的,什么都很方便从有另另十个 Theia版本升级到原本版本。

  缺点:

  • 时需遵守预定义的API。可能性这麼通过API提供contribution point,则可能性性对功能进行调整。注意当前的API都都都上能 进行扩展以支持更多的功能。

设计

  Theia程序由有另另十个 核心组成,它为特定功能提供一组小部件、命令和补救程序等。

  Theia定义了有另另十个 运行时的API,它允许插件定制IDE并将它们的功能加带到Theia程序的各个地方。

  在Theia中,插件都都都上能 通过有另另十个 名为theia的对象访问API,该对象在所有的插件中都可用。有关API的更多细节都都都上能 查看

这里

  插件有三种性质:

  • 后端插件。后端插件与VS Code的插件很像。插件的代码运行在服务端当事人独立的程序中。当API被调用时,它会在用户的浏览器或UI上发送什么都actions来注册新命令,等等。所有的回调不是服务端专有的程序中运行。

  • 前端插件。三种请况下所有的回调不是浏览器或UI的工作程序中运行。哪几个插件只被授权使用“浏览器兼容”模块。相似,不允许读写文件,可能性所有的插件都运行在浏览器端。有只是 ,可能性你觉得希望在客户端补救什么都网络操作,这麼三种措施是有用的。

必要条件

  这里有有另另十个 运行的Theia实例,(v0.3.12+)都都都上能 从Theia仓库获得Theia的说明。

项目形态

  大伙儿创建了有另另十个 名为theia-hello-world-plugin的新目录,用来存放大伙儿项目的源代码。

  三种新目录都都都上能 创建在任何路径下,它是独立于Theia源代码的。

  都都都上能 通过下面的命令来安装和运行生成器。注意,你要在运行Theia实例的新终端中输入哪几个命令。

npm install -g yo @theia/generator-plugin
mkdir theia-hello-world-plugin
cd theia-hello-world-plugin
yo @theia/plugin

  在上面的命令中:

  • npm install -g yo @theia/generator-plugin命令在全局安装Theia生成器。

  • yo @theia/plugin命令调用yeoman生成器来创建Theia插件生成器的模板。

  下面是生成器运行的动态图。

  每个哪几个的间题使用默认选项即可。

  在三种步中,theia-hello-world-plugin目录中可能性有了有另另十个 从源码构建的插件了。

实现插件

  大伙儿来看下自动生成的代码。

{
      "name": "theia-hello-world-plugin",
      "publisher": "theia",
      "keywords": [
        "theia-plugin"
      ],
      "version": "0.0.1",
      "files": [
        "src"
      ],
      "devDependencies": {
        "@theia/plugin": "latest", <-- 1. Theia API dependency
        "rimraf": "^2.6.2",
        "typescript": "^2.9.2"
      },
      "scripts": {
        "prepare": "yarn run clean && yarn run build",
        "clean": "rimraf lib",
        "build": "tsc"
      },
      "engines": {
        "theiaPlugin": "latest"  <-- 2. this plug-in requires Theia runtime
      },
      "theiaPlugin": {
        "backend": "lib/theia-hello-world-plugin-backend-plugin.js" 3. <-- entrypoint
      }
}

  在三种package.json文件中,有有另另十个 重要的偏离 :

  1. 首先,在devDependencies中,有有另另十个 依赖项@theia/plugin,三种包将在插件的代码中调用Theia API(如加带新命令和显示消息)。

  2. 第二,engines偏离 涵盖theiaPlugin,它允许将node包标记为可在特定版本的Theia上运行。

  3. 第三,theiaPlugin偏离 涵盖插件的入口位置。对于后端插件,backend的值是指向插件的javascript的路径。

  大伙儿来看下生成的单个源代码文件的内容。下面三种文件的路径是src/theia-hello-world-plugin-backend-plugin.ts,它涵盖TypeScript代码。

import * as theia from '@theia/plugin';

export function start() {
    const informationMessageTestCommand = {
        id: 'hello-world-example-generated',
        label: "Hello World"
    };
    theia.commands.registerCommand(informationMessageTestCommand, (...args: any[]) => {
        theia.window.showInformationMessage('Hello World!');
    });

}

export function stop() {

}

  都都都上能 看了,只需几行代码就都都都上能 注册有另另十个 命令并显示通知消息。

  第一行很重要,用来导入API。import * as theia from '@theia/plugin';将所有的Theia插件的API导入到有另另十个 theia对象中。

  代码中包涵盖另另十个 措施,start()stop()

  措施start()在插件被加载时调用。在三种措施中,有有另另十个 action,用来注册hello world命令和有另另十个 回调,以及显示hello world的消息。Command对象有有另另十个 id和有另另十个 用来在命令面板中显示的label

  措施stop()的内容为空,它在插件停止时被调用,用于执行什么都操作。此措施是可选的,可能性为空则都都都上能 将其删除。

运行插件

  现在大伙儿来看看三种插件的运行请况。在Theia涵盖三种被称之为hosted mode的模式,该模式允许大伙儿在其涵盖另另十个 Theia实例中开发插件,并将其部署到原本Theia实例中。原本就都都都上能 很方便地生成插件并进行测试。

  首先,确保可能性打开Theia中生成插件的目录(它时需不是你workspace的一偏离 )。有只是 打开命令面板(F1键),搜索Hosted mode: start instance,选者该命令。

  浏览workspace并选者插件的目录(其中涵盖package.json文件)。

  这将在100100端口上启有另另十个 新的Theia实例。你要看了打开了有另另十个 新的选项卡(可能性你时需验证一下),有有另另十个 新的实例在Development Host下运行(都都都上能 在请况栏中看了)。

  在Development Host实例中,打开命令面板(F1键)有只是 搜索Hello World命令。

  选者该命令,你将在屏幕上看了Hello World的消息。

开发插件

  正如上面所说的,Theia API由TypeScript提供,共同在开发过程中还支持代码补全功能和JsDoc。

更新插件

   假使 你想将消息的内容从Hello World改成Hello Theia,都都都上能 进到Hosted Plugin: running实例中(看请况栏上的显示),编辑TypeScript文件src/theia-hello-world-plugin-backend-plugin.ts,将theia.window.showInformationMessage('Hello World!');改成theia.window.showInformationMessage('Hello Theia!');

  在插件的根目录下运行命令yarn build,重新编译源代码。有只是 你只时需刷新Development Host的实例,插件就会被重新加载。

  注意:你也都都都上能 使用watch模式来代替手动刷新。

插件的API

VS Code代码实现