使用Theia——创建扩展包

  • 时间:
  • 浏览:0
  • 来源:幸运快3_快3单双_幸运快3单双

上一篇:使用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:4000,在打开的应用多多系统进程 中选泽 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