使用Theia——创建扩展包

  • 时间:
  • 浏览:2
  • 来源:幸运快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:300,在打开的程序运行运行运行中挑选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