Theia 是一个开源的可扩展的IDE框架,可以用于构建自定义的开发环境。本指南将带你逐步完成在 Windows 环境下搭建 Theia 项目所需的所有步骤,包括安装必要的软件和工具、设置环境变量以及构建和运行项目。
准备工作
项目搭建的环境准备条件,如果不具备也没关系,后面的搭建步骤也会逐个安装(除了python需要通过下载安装):
-
安装了 Node.js。推荐版本为 18.17.0,但必须满足以下条件:
- Node.js 版本应为
>= 18.17.0且< 21。 - 如果希望使用 Theia 的 VS Code 扩展支持,则应使用与 VS Code 使用的 Electron 版本兼容的 Node.js 版本。
- Node.js 版本应为
-
安装了 Yarn 包管理器,版本
>= 1.7.0且< 2.x.x。 -
安装了 Git,如果计划使用 Git 扩展,则需要版本
2.11.0或更高版本。 -
Python3 是必需的用于构建,因为
node-gyp@8.4.1需要它。(python3各版本均可,但建议不高于3.10,因为3.10以上移除了distutils,需要单独安装,推荐3.6)
在 Windows 上搭建步骤
1. 安装 scoop
scoop 是一个 Windows 的命令行工具,用于安装常用的开发工具和软件包。你可以使用以下命令来安装 scoop:
iwr -useb get.scoop.sh | iex
2. 使用 scoop 安装 nvm
nvm 是 Node.js 的版本管理工具,它可以让你轻松地管理不同版本的 Node.js。你可以使用以下命令来使用 scoop 安装 nvm:
scoop install nvm
3. 使用 nvm 安装 Node.js
使用 nvm 安装 Node.js,推荐使用版本 18.17.0:
nvm install 18.17.0
然后使用安装的 Node.js 版本:
nvm use 18.17.0
4. 使用 scoop 安装 Yarn
使用 scoop 安装 Yarn:
scoop install yarn
5. 安装 Windows 构建工具
Windows 构建工具是必需的用于构建 Theia 项目中的原生 Node 模块。你可以使用以下命令来安装它们:
npm --add-python-to-path install --global --production windows-build-tools
6. 使用 scoop 安装 Git
使用 scoop 安装 Git:
scoop install git
7. 克隆、构建和运行 Theia 项目
在项目文件处的 Git Bash 中以管理员身份运行以下命令,以克隆、构建和运行 Theia 项目:
git clone https://github.com/eclipse-theia/theia.git \
&& cd theia \
&& yarn \
&& yarn browser build \
&& yarn browser start
启动成功后通过http://localhost:3000就可以访问了
如果你不想要web端的,还可以构建和运行electron客户端项目
yarn download:plugins \
&& yarn electron build \
&& yarn electron start
总结
Theia具有丰富的API,方便进行IDE的二次开发和私有开发环境的定制,主流的WebIDE很多都是基于此项目的,项目搭建也比较容易,是一个很好的学习和业务使用的项目。
如果觉得有帮助,麻烦帮忙点个赞!如果搭建过程中遇到什么问题,欢迎在评论区沟通交流!如果感兴趣的人多,也会进一步分享Theia的相关学习笔记。