使用Theia——创建插件

  • 时间:
  • 浏览:2
  • 来源:大发uu快3_uu快3大小_大发uu快3大小

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

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