使用Theia——创建插件

  • 时间:
  • 浏览:0

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

创建Theia插件

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

Theia的架构

插件与扩展包

  Theia是一一有有有四个可扩展的IDE。你原困听说过扩展是定制IDE的并都不 办法,而插件则是并都不 可不都还可不能能被加进去去到Theia中的新的可扩展模型。下面是或多或少有关插件和扩展包之间的主要区别。

插件

  优点:

  • 代码隔离:插件的代码运行在独立的tcp连接中,它不要阻塞Theia核心tcp连接。

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

  • 减少编译时间。

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

  • 简单的API

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

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

  • 原困API是向后兼容的,也不很方便从一一有有有四个Theia版本升级到而且版本。

  缺点:

  • 都要遵守预定义的API。原困没有 通过API提供contribution point,则不原困对功能进行调整。注意当前的API可不都还可不能能进行扩展以支持更多的功能。

设计

  Theia应用tcp连接由一一有有有四个核心组成,它为特定功能提供一组小部件、命令和防止tcp连接等。

  Theia定义了一一有有有四个运行时的API,它允许插件定制IDE并将它们的功能加进去去到Theia应用tcp连接的各个地方。

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

这里

  插件有并都不 性质:

  • 后端插件。后端插件与VS Code的插件很像。插件的代码运行在服务端我本人独立的tcp连接中。当API被调用时,它会在用户的浏览器或UI上发送或多或少actions来注册新命令,等等。所有的回调全部都不 服务端专有的tcp连接中运行。

  • 前端插件。或多或少具体情况下所有的回调全部都不 浏览器或UI的工作tcp连接中运行。哪几个插件只被授权使用“浏览器兼容”模块。同类,不允许读写文件,原困所有的插件都运行在浏览器端。而且,原困你虽然希望在客户端防止或多或少网络操作,没有 或多或少办法是有用的。

必要条件

  这里有一一有有有四个运行的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文件)。

  这将在8080端口上启一一有有有四个新的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代码实现