使用Theia——创建插件

  • 时间:
  • 浏览:0

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

创建Theia插件

  下面朋友 来看看怎么才能 才能 创建Theia插件。作为示例,朋友 将注册有2个多Hello World命令,该命令显示有2个多“Hello World”通知。本文将指导你完成所有必要的步骤。

Theia的架构

插件与扩展包

  Theia是有2个多可扩展的IDE。你不可能 听说过扩展是定制IDE的四种 办法,而插件则是四种 能要能被去掉 到Theia中的新的可扩展模型。下面是这名有关插件和扩展包之间的主要区别。

插件

  优点:

  • 代码隔离:插件的代码运行在独立的任务管理器运行运行中,它不需要阻塞Theia核心任务管理器运行运行。

  • 能要能在运行时加载。不须要重新编译整个Theia IDE。

  • 减少编译时间。

  • 自含晒 。插件能要能被打包成有2个多独立的文件,并在稍后直接加载。它不须要从npmjs不可能 其它的地方获取额外的依赖项。

  • 简单的API

  • 不须要学习inversify或任何其它的框架。

  • 单个入口,含晒 代码补全,以查看不可能 的与JsDoc相关的调用。

  • 不可能 API是向后兼容的,很多很多很方便从有2个多Theia版本升级到曾经版本。

  缺点:

  • 须要遵守预定义的API。不可能 如此通过API提供contribution point,则不需要可能 对功能进行调整。注意当前的API能要能进行扩展以支持更多的功能。

设计

  Theia任务管理器运行运行由有2个多核心组成,它为特定功能提供一组小部件、命令和处里任务管理器运行等。

  Theia定义了有2个多运行时的API,它允许插件定制IDE并将它们的功能去掉 到Theia任务管理器运行运行的各个地方。

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

这里

  插件有四种 性质:

  • 后端插件。后端插件与VS Code的插件很像。插件的代码运行在服务端这名人独立的任务管理器运行运行中。当API被调用时,它会在用户的浏览器或UI上发送这名actions来注册新命令,等等。所有的回调就有服务端专有的任务管理器运行运行中运行。

  • 前端插件。这名情况汇报下所有的回调就有浏览器或UI的工作任务管理器运行中运行。有有哪些插件只被授权使用“浏览器兼容”模块。例如,不允许读写文件,不可能 所有的插件都运行在浏览器端。不需要,不可能 你确实希望在客户端处里这名网络操作,如此这名办法是有用的。

必要条件

  这里有有2个多运行的Theia实例,(v0.3.12+)能要能从Theia仓库获得Theia的说明。

项目内控

  朋友 创建了有2个多名为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目录中不可能 有了有2个多从源码构建的插件了。

实现插件

  朋友 来看下自动生成的代码。

{
      "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文件中,有有2个多重要的帕累托图:

  1. 首先,在devDependencies中,有有2个多依赖项@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() {

}

  能要能看到,只需几行代码就能要能注册有2个多命令并显示通知消息。

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

  代码含晒 晒 晒 2个多办法,start()stop()

  办法start()在插件被加载时调用。在这名办法中,有有2个多action,用来注册hello world命令和有2个多回调,以及显示hello world的消息。Command对象有有2个多id和有2个多用来在命令面板中显示的label

  办法stop()的内容为空,它在插件停止时被调用,用于执行这名操作。此办法是可选的,不可能 为空则能要能将其删除。

运行插件

  现在朋友 来看看这名插件的运行情况汇报。在Theia含晒 四种 被称之为hosted mode的模式,该模式允许朋友 在其含晒 2个多Theia实例中开发插件,并将其部署到曾经Theia实例中。曾经就能要能很方便地生成插件并进行测试。

  首先,确保不可能 打开Theia中生成插件的目录(它须要有你在身边workspace的一帕累托图)。不需要打开命令面板(F1键),搜索Hosted mode: start instance,选择该命令。

  浏览workspace并选择插件的目录(其含晒 晒 package.json文件)。

  这将在200200端口上启有2个多新的Theia实例。不需要看到打开了有2个多新的选项卡(不可能 你须要验证一下),有有2个多新的实例在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代码实现