使用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文件)。

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