使用Theia——创建扩展包

  • 时间:
  • 浏览:0

上一篇:使用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:60 0,在打开的线程中选则 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