使用Theia——创建扩展包

  • 时间:
  • 浏览:1
  • 来源:大发pk10_pk10彩神8_大发pk10彩神8

上一篇:使用Theia——构建你买车人的IDE

创建Theia扩展包

  本例中,你四种 及将加带另一个 菜单项“Say hello”用来显示另一个 通知“Hello world!”。本文将指导你完成所有必要的步骤。

Theia的架构

  Theia守护进程由所谓的扩展包(extensions)构成。另一个 扩展包提供一组特定功能的小部件、命令和正确处理守护进程等。Theia有四种 提供了你四种 扩展包,如编辑器、终端、项目视图等。每另一个 扩展包都属于它们每每本人的npm包。

  Theia定义了小量的contribution接口,允许扩展包将功能加带到守护进程的各个每段。只都都后能 按名称搜索*Contribution就都都后能 找到那此接口。扩展包实现了那此contribution接口的具体功能。在本例中,你四种 及将实现CommandContributionMenuContribution。扩展包与Theia守护进程之间还都都后能 通过各种servicesmanagers来进行交互。

  在Theia中,所有的东西都都后能 通过依赖注入(

Dependency Injection

)的办法连接起来的。另一个 扩展包定义了另一个 或多个依赖注入模块。那此依赖注入模块要是 绑定并实现contribution接口的地方,它们被列在扩展包的

package.json

文件中。扩展包都都后能 用于前端,相似提供UI扩展,也都都后能 用于后端,相似提供语言服务。当守护进程启动时,所有那此模块合并起来为前端和后端每每本人配置另一个 全局的依赖注入容器。倘若在运行时通很多次注入的办法将那此特定类型的contributions分发起来。

必要条件

  愿意 安装node 10版本(译者:事实上最新的node稳定版即可):

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
nvm install 10

  以及yarn:

  还都都后能 确保已安装python 2.x,可通过python --version来检查。

项目形态

  你四种 及将创建另一个 名为theia-hello-world-extension的monorepo(另一个 中含多个npm包的仓库),其中含高另一个 包:hello-world-extensionbrowser-appelectron-app。第另一个 即你四种 及的扩展包,后另一个 是在浏览器和electron模式下运行你四种 及扩展包的Theia守护进程。这里你四种 及使用yarn而都都后能 npm来安装,之前 它都都后能 在workspace中构造monorepo仓库的形态。在你四种 及的示例中,每另一个 workspace都中含它们买车人的npm包。那此包的公共依赖项通过yarn被“hoisted”到它们的公共根目录中。另外你四种 及还将使用lerna跨workspace运行脚本。

  为了比较复杂每个仓库的设置,你四种 及创建了另一个

代码生成器

来帮助你四种 及快速生成项目的脚手架。它也会生成

hello-world

示例,通过下面的命令运行:

npm install -g yo generator-theia-extension
mkdir theia-hello-world-extension
cd theia-hello-world-extension
yo theia-extension hello-world-extension

  你四种 及来看下生成的代码。根目录下的package.json文件中定义了workspaces、依赖项lerna以及你四种 用来给浏览器或electron构件本地包的scripts。

{
  "private": true,
  "scripts": {
    "prepare": "lerna run prepare",
    "rebuild:browser": "theia rebuild:browser",
    "rebuild:electron": "theia rebuild:electron"
  },
  "devDependencies": {
    "lerna": "2.4.0"
  },
  "workspaces": [
    "hello-world-extension", "browser-app", "electron-app"
  ]
}

  并肩也生成了lerna.json文件,用来配置lerna

{
  "lerna": "2.4.0",
  "version": "0.1.0",
  "useWorkspaces": true,
  "npmClient": "yarn",
  "command": {
    "run": {
      "stream": true
    }
  }
}

实现扩展包

  接下来看下hello-world-extension目录中你四种 及的扩展包生成的代码。你四种 及从package.json文件现在现在开始,它定义了包的元数据、对(最新的)Theia核心包的依赖项、你四种 脚本以及开发依赖项、还有theia-extensions。

  keywords中的theia-extension非常重要:它允许Theia守护进程都都后能 识别并从npm安装Theia扩展包。

{
  "name": "hello-world-extension",
  "keywords": [
    "theia-extension"
  ],
  "version": "0.1.0",
  "files": [
    "lib",
    "src"
  ],
  "dependencies": {
    "@theia/core": "latest"
  },
  "devDependencies": {
    "rimraf": "latest",
    "typescript": "latest"
  },
  "scripts": {
    "prepare": "yarn run clean && yarn run build",
    "clean": "rimraf lib",
    "build": "tsc",
    "watch": "tsc -w"
  },
  "theiaExtensions": [
    {
      "frontend": "lib/browser/hello-world-frontend-module"
    }
  ]
}

  最后另一个 属性theiaExtensions,其中列出了你四种 JavaScript模块,那此模块导出了扩展包中定义的contribution的DI模块。本例中,你四种 及只提供了另一个 前端功能(另一个 命令行和另一个 菜单项)。相似地,你也都都后能 定义对后端的contribution,相似定义另一个 使用语言服务的language contribution。

  在前端模块中,你四种 及导出了另一个 默认对象,

InversifyJS

ContainerModule

,其中绑定了另一个 command contribution和另一个 menu contribution。

export default new ContainerModule(bind => {
    // add your contribution bindings here
    bind(CommandContribution).to(HelloWorldCommandContribution);
    bind(MenuContribution).to(HelloWorldMenuContribution);
});

  Command被定义为有四种 简单的数据形态,其中含高id和label。id中含高了在command contribution中注册的正确处理守护进程,用来实现command的功能。代码生成器之前 加带了另一个 command和另一个 正确处理守护进程,用于显示另一个 “Hello World!”的消息。

export const HelloWorldCommand = {
    id: 'HelloWorld.command',
    label: "Shows a message"
};

@injectable()
export class HelloWorldCommandContribution implements CommandContribution {

    constructor(
        @inject(MessageService) private readonly messageService: MessageService,
    ) { }

    registerCommands(registry: CommandRegistry): void {
        registry.registerCommand(HelloWorldCommand, {
            execute: () => this.messageService.info('Hello World!')
        });
    }
}
...

  请注意你四种 及是怎样才能在构造函数中使用@inject来获取MessageService的,以及怎样才能在稍后的正确处理守护进程中使用它。这要是 依赖注入优雅的地方:在客户端,你四种 及不用说关心那此依赖来自于何处,倘若要是 关心它们的生命周期。

  为了能在UI层访问,你四种 及都都后能 实现MenuContribution,在菜单栏的edit菜单的Search/Replace每段加带一项。

...
@injectable()
export class HelloWorldMenuContribution implements MenuContribution {

    registerMenus(menus: MenuModelRegistry): void {
        menus.registerMenuAction(CommonMenus.EDIT_FIND, {
                commandId: HelloWorldCommand.id,
                label: 'Say Hello'
            });
    }
}

在浏览器中运行扩展包

  现在来看看你四种 及的扩展包是怎样才能工作的。为此,生成器在browser-app目录中创建了另一个 package.json文件,定义了另一个 中含有几个扩展包的Theia浏览器守护进程,其中含高了你四种 及的hello-world-extension。目录中剩余的其它文件都都后能 由yarn在构建过程中通过theia-cli工具自动生成的,如scripts每段中所定义的。

{
  "name": "browser-app",
  "version": "0.1.0",
  "dependencies": {
    "@theia/core": "latest",
    "@theia/filesystem": "latest",
    "@theia/workspace": "latest",
    "@theia/preferences": "latest",
    "@theia/navigator": "latest",
    "@theia/process": "latest",
    "@theia/terminal": "latest",
    "@theia/editor": "latest",
    "@theia/languages": "latest",
    "@theia/markers": "latest",
    "@theia/monaco": "latest",
    "@theia/typescript": "latest",
    "@theia/messages": "latest",
    "hello-world-extension": "0.1.0"
  },
  "devDependencies": {
    "@theia/cli": "latest"
  },
  "scripts": {
    "prepare": "theia build",
    "start": "theia start",
    "watch": "theia build --watch"
  },
  "theia": {
    "target": "browser"
  }
}

  现在所有构建和运行守护进程都都后能 的每段都准备好了,要运行它,输入下面的命令:

cd browser-app
yarn start <path to workspace>

  倘若在浏览器中输入http://localhost:10000,在打开的守护进程中选折 Edit>Say Hello,你之前 看后 “Hello World!”的消息弹出。

在Electron中运行扩展包

  Electron守护进程中的package.json与浏览器守护进程中的相似,除了name和target属性不同。

{
  "name": "electron-app",
  ...
  "theia": {
    "target": "electron"
  }
}

  在运行electron守护进程之前 ,愿意 重新构建你四种 本地的模块:

yarn rebuild:electron
cd electron-app
yarn start <path to workspace>

部署扩展包

  之前 你想公开你的扩展包,你四种 及建议你将它发布到npm。我能 通过在扩展包的目录中调用yarn publish来完成,当然前提没有愿意 另一个 有效的账户。

原文地址:https://theia-ide.org/docs/authoring_extensions