使用Theia——创建插件

  • 时间:
  • 浏览:0
  • 来源:十分时时彩_十分时时彩网投平台_线上十分时时彩投注平台

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

创建Theia插件

  下面亲戚亲戚朋友 来看看如保创建Theia插件。作为示例,亲戚亲戚朋友 将注册2个 Hello World命令,该命令显示2个 “Hello World”通知。本文将指导你完成所有必要的步骤。

Theia的架构

插件与扩展包

  Theia是2个 可扩展的IDE。你将会听说过扩展是定制IDE的并全部都是最好的方法,而插件则是并全部都是还还要被加进到Theia中的新的可扩展模型。下面是或多或少有关插件和扩展包之间的主要区别。

插件

  优点:

  • 代码隔离:插件的代码运行在独立的应用程序池池中,它不让阻塞Theia核心应用程序池池。

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

  • 减少编译时间。

  • 自所含。插件还还要被打包成2个 独立的文件,并在稍后直接加载。它不还要从npmjs将会其它的地方获取额外的依赖项。

  • 简单的API

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

  • 单个入口,所含代码补全,以查看将会的与JsDoc相关的调用。

  • 将会API是向后兼容的,很多 很方便从2个 Theia版本升级到曾经 版本。

  缺点:

  • 还要遵守预定义的API。将会那么 通过API提供contribution point,则不将会对功能进行调整。注意当前的API还还要进行扩展以支持更多的功能。

设计

  Theia应用应用程序池池由2个 核心组成,它为特定功能提供一组小部件、命令和外理应用程序池池等。

  Theia定义了2个 运行时的API,它允许插件定制IDE并将它们的功能加进到Theia应用应用程序池池的各个地方。

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

这里

  插件有并全部都是性质:

  • 后端插件。后端插件与VS Code的插件很像。插件的代码运行在服务端自己独立的应用程序池池中。当API被调用时,它会在用户的浏览器或UI上发送或多或少actions来注册新命令,等等。所有的回调总要 服务端专有的应用程序池池中运行。

  • 前端插件。這個请况下所有的回调总要 浏览器或UI的工作应用程序池中运行。哪此插件只被授权使用“浏览器兼容”模块。相似,不允许读写文件,将会所有的插件都运行在浏览器端。我希望,将会你随便说说希望在客户端外理或多或少网络操作,那么 這個最好的方法是有用的。

必要条件

  这里有2个 运行的Theia实例,(v0.3.12+)还还要从Theia仓库获得Theia的说明。

项目内控

  亲戚亲戚朋友 创建了2个 名为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目录中将会有了2个 从源码构建的插件了。

实现插件

  亲戚亲戚朋友 来看下自动生成的代码。

{
      "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文件中,有2个 重要的累积:

  1. 首先,在devDependencies中,有2个 依赖项@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() {

}

  还还要想看 ,只需几行代码就还还要注册2个 命令并显示通知消息。

  第一行有点要,用来导入API。import * as theia from '@theia/plugin';将所有的Theia插件的API导入到2个 theia对象中。

  代码中所含2个 最好的方法,start()stop()

  最好的方法start()在插件被加载时调用。在這個最好的方法中,有2个 action,用来注册hello world命令和2个 回调,以及显示hello world的消息。Command对象有2个 id和2个 用来在命令面板中显示的label

  最好的方法stop()的内容为空,它在插件停止时被调用,用于执行或多或少操作。此最好的方法是可选的,将会为空则还还要将其删除。

运行插件

  现在亲戚亲戚朋友 来看看這個插件的运行请况。在Theia所含并全部都是被称之为hosted mode的模式,该模式允许亲戚亲戚朋友 在其中2个 Theia实例中开发插件,并将其部署到曾经 Theia实例中。曾经 就还还要很方便地生成插件并进行测试。

  首先,确保将会打开Theia中生成插件的目录(它还要那个她 workspace的一累积)。我希望打开命令面板(F1键),搜索Hosted mode: start instance,选着该命令。

  浏览workspace并选着插件的目录(其中所含package.json文件)。

  这将在300300端口上启2个 新的Theia实例。我就想看 打开了2个 新的选项卡(将会你还要验证一下),有2个 新的实例在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代码实现