使用Theia——创建插件

  • 时间:
  • 浏览:0
  • 来源:5分时时彩官网_5分时时彩正规平台_5分时时彩平台网址

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

  这将在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代码实现