使用Theia——创建插件

  • 时间:
  • 浏览:9
  • 来源:大发快三_快三平台网址_大发快三平台网址

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

  这将在400400端口上启一一十个 多 多新的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代码实现