使用Theia——创建插件

  • 时间:
  • 浏览:1
  • 来源:五分时时彩_五分时时彩正规平台_五分时时彩平台网址

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

创建Theia插件

  下面我们歌词 歌词 来看看要怎样创建Theia插件。作为示例,我们歌词 歌词 将注册另好几个 Hello World命令,该命令显示另好几个 “Hello World”通知。本文将指导你完成所有必要的步骤。

Theia的架构

插件与扩展包

  Theia是另好几个 可扩展的IDE。你另另好几个 听说过扩展是定制IDE的五种最好的妙招,而插件则是五种需要被换成到Theia中的新的可扩展模型。下面是你这名有关插件和扩展包之间的主要区别。

插件

  优点:

  • 代码隔离:插件的代码运行在独立的应用应用tcp连接中,它不要再阻塞Theia核心应用应用tcp连接。

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

  • 减少编译时间。

  • 自蕴藏。插件需要被打包成另好几个 独立的文件,并在稍后直接加载。它需要从npmjs另另好几个 其它的地方获取额外的依赖项。

  • 简单的API

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

  • 单个入口,蕴藏代码补全,以查看另另好几个 的与JsDoc相关的调用。

  • 另另好几个 API是向后兼容的,后后很方便从另好几个 Theia版本升级到另另好几个 版本。

  缺点:

  • 需要遵守预定义的API。另另好几个 没办法 通过API提供contribution point,则不另另好几个 对功能进行调整。注意当前的API需要进行扩展以支持更多的功能。

设计

  Theia应用应用tcp连接由另好几个 核心组成,它为特定功能提供一组小部件、命令和补救应用tcp连接等。

  Theia定义了另好几个 运行时的API,它允许插件定制IDE并将它们的功能换成到Theia应用应用tcp连接的各个地方。

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

这里

  插件有五种性质:

  • 后端插件。后端插件与VS Code的插件很像。插件的代码运行在服务端个人独立的应用应用tcp连接中。当API被调用时,它会在用户的浏览器或UI上发送你这名actions来注册新命令,等等。所有的回调都是服务端专有的应用应用tcp连接中运行。

  • 前端插件。你这名具体情况下所有的回调都是浏览器或UI的工作应用tcp连接中运行。有有哪些插件只被授权使用“浏览器兼容”模块。之类,不允许读写文件,另另好几个 所有的插件都运行在浏览器端。但会 ,另另好几个 你虽然希望在客户端补救你这名网络操作,没办法 你这名最好的妙招是有用的。

必要条件

  这里有另好几个 运行的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代码实现