使用Theia——创建扩展包

  • 时间:
  • 浏览:0

上一篇:使用Theia——构建你当事人的IDE

创建Theia扩展包

  本例中,亲戚亲戚这人 人儿将上加4个菜单项“Say hello”用来显示4个通知“Hello world!”。本文将指导你完成所有必要的步骤。

Theia的架构

  Theia应用任务管理器由所谓的扩展包(extensions)构成。4个扩展包提供一组特定功能的小部件、命令和出理 任务管理器等。Theia这人提供了这人 扩展包,如编辑器、终端、项目视图等。每4个扩展包都属于它们所有人的npm包。

  Theia定义了一定量的contribution接口,允许扩展包将功能上加到应用任务管理器的各个次责。只前要按名称搜索*Contribution就还前要找到哪些地方地方接口。扩展包实现了哪些地方地方contribution接口的具体功能。在本例中,亲戚亲戚这人 人儿将实现CommandContributionMenuContribution。扩展包与Theia应用任务管理器之间还还前要通过各种servicesmanagers来进行交互。

  在Theia中,所有的东西一定会通过依赖注入(

Dependency Injection

)的最好的措施连接起来的。4个扩展包定义了4个或多个依赖注入模块。哪些地方地方依赖注入模块就是绑定并实现contribution接口的地方,它们被列在扩展包的

package.json

文件中。扩展包还前要用于前端,累似 提供UI扩展,也还前要用于后端,累似 提供语言服务。当应用任务管理器启动时,所哪些地方地方地方模块合并起来为前端和后端所有人配置4个全局的依赖注入容器。就是在运行时通越来越来越多次注入的最好的措施将哪些地方地方特定类型的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来检查。

项目社会形态

  亲戚亲戚这人 人儿将创建4个名为theia-hello-world-extension的monorepo(4个富含多个npm包的仓库),其中富含4个包:hello-world-extensionbrowser-appelectron-app。第4个即亲戚亲戚这人 人儿的扩展包,后4个是在浏览器和electron模式下运行亲戚亲戚这人 人儿扩展包的Theia应用任务管理器。这里亲戚亲戚这人 人儿使用yarn而一定会npm来安装,机会它还前要在workspace中构造monorepo仓库的社会形态。在亲戚亲戚这人 人儿的示例中,每4个workspace都富含它们当事人的npm包。哪些地方地方包的公共依赖项通过yarn被“hoisted”到它们的公共根目录中。另外亲戚亲戚这人 人儿还将使用lerna跨workspace运行脚本。

  为了复杂每个仓库的设置,亲戚亲戚这人 人儿创建了4个

代码生成器

来帮助亲戚亲戚这人 人儿快速生成项目的脚手架。它也会生成

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"
    }
  ]
}

  最后4个属性theiaExtensions,其中列出了这人 JavaScript模块,哪些地方地方模块导出了扩展包中定义的contribution的DI模块。本例中,亲戚亲戚这人 人儿只提供了4个前端功能(4个命令行和4个菜单项)。累似 地,你也还前要定义对后端的contribution,累似 定义4个使用语言服务的language contribution。

  在前端模块中,亲戚亲戚这人 人儿导出了4个默认对象,

InversifyJS

ContainerModule

,其中绑定了4个command contribution和4个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的功能。代码生成器机会上加了4个command和4个出理 任务管理器,用于显示4个“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目录中创建了4个package.json文件,定义了4个富含几次扩展包的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:30000,在打开的应用任务管理器中选折 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来完成,当然前提有了你前要4个有效的账户。

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