使用Theia——创建插件

  • 时间:
  • 浏览:0

上一篇:使用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文件)。

  这将在10001000端口上启五个新的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代码实现