前言
@theia/plugin 是适用于基于 Web 技术栈的桌面应用程序开发工具包,主要使用 TypeScript 和 VS Code 插件系统进行开发。本教程将详细介绍如何使用 npm 包 @theia/plugin 进行开发,包括安装、配置和使用方法,旨在帮助开发者更快速地上手使用该工具包。
安装与配置
首先,我们打开控制台(Terminal/命令行),通过 npm 进行安装,具体命令如下:
npm install @theia/plugin
安装完成后,我们需要进行配置,并添加必要的依赖项。
第一步:配置工程
- 在工程目录下新建 .theia 文件夹
在该文件夹下,新建一个文件,名为 launch.json。该文件主要用于配置应用程序的调试和运行环境。
我们在 launch.json 中添加以下代码:
-- -------------------- ---- ------- - ---------- -------- ----------------- - - ------- ------- ------- ------- --------- --------------- ---------- --------- -------------------- -------------------------------------------------- -------------- - ------------------ ------------------------------- -- ----------- -- - - -
第二步:添加依赖
除了 @theia/plugin,我们还需要添加以下依赖:
- dependencies
{ "@types/node": "^14.14.37", "electron": "^13.1.9" }
- devDependencies
{ "ts-node": "^10.2.1", "typescript": "^4.3.5" }
这里我们使用 electron 作为我们的桌面化技术栈,ts-node 作为 TypeScript 的编译器,需要注意,electron 版本要和 NodeJS 版本对应,具体可以查看:https://github.com/electron/electron/releases。
开始使用 @theia/plugin
1. 创建插件
@theia/plugin 提供了 create-theia-plugin 脚手架,帮助我们创建一个最基础的插件。
我们在控制台输入以下命令:
npx -p yo -p generator-code yo code
选择 Extension 选项,按照提示进行操作,接下来会生成一个最简单的扩展程序。我们可以继续在该基础上进行开发。
2. 配置 vscode 本地化环境
如果在使用 @theia/plugin 进行开发时涉及 vscode 插件开发相关的功能,需要额外配置一下 vscode 本地化环境。
在 .theia 文件夹下创建 settings.json 文件,添加以下代码:
-- -------------------- ---- ------- - --------- - --------------------------- ------------------- --------------------- ---------------------------------------------- ----------------------------------- ----- ------------------------------ ----- ------------------------------------ ----------- ---------------------------- ------ -------------------------------- ----- - -
3. 编写代码
在 package.json 中添加以下代码:
-- -------------------- ---- ------- - --------------- - --------- --------- -------- ------ -- --------------- - -------------- ---------- ---------------- ---------- -------------------- ---------- ------------------- ---------- ----------------- ---------- ------------------ ---------- ---------------- ---------- ---------------------- ---------- --------------------------- ---------- ---------------------------- ---------- --------------------- ---------- -------------------- ---------- ------------------ ---------- --------------------------- --------- -- ---------- - ----------------- ------------- ------- ---------------------- - -
这些依赖项是开发常用的,包括 theia 库、VS Code 库和一些扩展程序。
接下来,我们编写一个最简单的插件代码,为 document 添加文件重命名功能。
在 src 文件夹下新建一个文件 renameDocument.ts:
-- -------------------- ---- ------- ------ - --------- ------- ---------------- - ---- ---------------- ------ -------- ----------------- ----------------- - --------------------------- -------------------------- --- ------------------------ ------ ------- ------ ---------- -------- ----- -- -- - ----- ------ - ----- ------------------------ -- --------- - ------- - ----- --- - ----------- ----- ------- - --------------- ----- --------- - ------------------------- ----- ------ - -------------------- --------- - --- ----- ------- - -------------------------------------------- - --- ----- ------- - ---------- - -------- ----- ------ - -------------------- --------- - -- - -------- ----- -------------------------------------------- ---- -------- -- -- -- -
修改 src-electron/main.ts:
-- -------------------- ---- ------- ------ - ---------- --------------- - ---- -------------- ------ - --------------------- - ---- -------------------- ------ ------- --- -------------------- -- - ----- --- - --- ------------------------ ------------------------------------------------- ---------------------------------- -- - ----- ----- - ------------------ ------------------------------------------------------- ------ ------ --- ---
现在,我们的 @theia/plugin 插件已经编写完成了。
小结
本文主要介绍了如何使用 @theia/plugin 进行桌面应用程序开发。我们从安装、配置、到具体的使用都进行了详细的介绍。希望这篇教程对初学者有所帮助,也能够激发大家的学习和创造热情。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/theia-plugin