极狐 GitLab Logo

Web IDE

  • Tier: 基础版, 专业版, 旗舰版
  • Offering: JihuLab.com, 私有化部署
History
    • 引入于极狐GitLab 15.7，使用名为 vscode_web_ide 的功能标志。默认禁用。
    • 在极狐GitLab 15.7 中，在 JihuLab.com 上启用。
    • 在极狐GitLab 15.11 中，在私有化部署上启用。
此功能的可用性受控于功能标志。更多信息，可查看历史。

极狐GitLab Web IDE 是一个高级编辑器，您可以在其中编辑多个文件，暂存更改，并直接在极狐GitLab UI 中创建提交。与 Web Editor 不同，Web IDE 提供了一个功能齐全的开发环境，具有源代码管理功能。

打开 Web IDE#

您可以通过多种方法访问 Web IDE。

使用键盘快捷键#

  1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
  2. 使用 . 键盘快捷键。

从文件或目录中#

  1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
  2. 前往您的文件或目录。
  3. 选择 编辑 > 在 Web IDE 中打开。

从合并请求中#

  1. 在左侧边栏中，选择 搜索或转到 并找到您的项目。
  2. 前往您的合并请求。
  3. 在右上角，选择 代码 > 在 Web IDE 中打开。

Web IDE 在单独的选项卡中打开新的和修改过的文件，并并排显示更改。为了减少加载时间，只有 10 个更改行数最多的文件会自动打开。

Web IDE 接口在左侧边栏的 资源管理器 视图中显示合并请求图标 (

) 在新建或修改的文件旁边。要查看文件的更改，右键单击该文件并选择 与合并请求基准比较。

管理文件#

您可以使用 Web IDE 打开、编辑和上传多个文件。

打开文件#

要在 Web IDE 中按名称打开文件：

  1. 按 Command+P。
  2. 在搜索框中输入文件名。

搜索打开的文件#

要在 Web IDE 中搜索打开的文件：

  1. 按 Shift+Command+F。
  2. 在搜索框中输入搜索词。

上传文件#

要在 Web IDE 中上传文件：

  1. 在 Web IDE 的左侧，选择 资源管理器 (

    )，或按 Shift+Command+E。

  2. 前往您想要上传文件的目录。要创建一个新目录：

    • 在 资源管理器 视图中，右上角选择 新建文件夹 ()。

  3. 右键单击目录并选择 上传。

  4. 选择要上传的文件。

您可以一次上传多个文件。文件会被上传并自动添加到存储库中。

恢复未提交的更改#

您不必手动保存您在 Web IDE 中编辑的任何文件。Web IDE 会暂存您修改的文件，以便您可以 提交更改。未提交的更改会保存在浏览器的本地存储中。即使关闭浏览器标签页或刷新 Web IDE，它们也会继续存在。

如果您的未提交更改不可用，您可以从本地历史记录中恢复更改。要在 Web IDE 中恢复未提交的更改：

  1. 按 Shift+Command+P。
  2. 在搜索框中输入 Local History: Find Entry to Restore。
  3. 选择包含未提交更改的文件。

使用源代码管理#

您可以使用源代码管理查看修改过的文件，创建和切换分支，提交更改，并创建合并请求。

查看修改过的文件#

要查看您在 Web IDE 中修改的文件列表：

  • 在 Web IDE 的左侧，选择 源代码管理 ()，或按 Control+Shift+G。

您的 CHANGES、STAGED CHANGES 和 MERGE CHANGES 会显示出来。

切换分支#

Web IDE 默认使用当前分支。要在 Web IDE 中切换分支：

  1. 在底部状态栏的左侧，选择当前分支名称。
  2. 输入或选择一个现有分支。

创建分支#

要在 Web IDE 中从当前分支创建分支：

  1. 在底部状态栏的左侧，选择当前分支名称。
  2. 从下拉列表中选择 创建新分支。
  3. 输入新分支名称。

如果您没有对存储库的写入权限，则 创建新分支 不可见。

提交更改#

要在 Web IDE 中提交更改：

  1. 在 Web IDE 的左侧，选择 源代码管理 ()，或按 Control+Shift+G。
  2. 输入您的提交信息。
  3. 提交到当前分支或 创建一个新分支。

创建合并请求#

要在 Web IDE 中创建 合并请求：

  1. 提交更改。
  2. 在右下角出现的通知中，选择 创建 MR。

有关更多信息，请参阅 查看错过的通知。

自定义 Web IDE#

根据您的偏好自定义 Web IDE 的键盘快捷键、主题、设置和同步。

使用命令面板#

您可以使用命令面板访问许多命令。要打开命令面板并在 Web IDE 中运行命令：

  1. 按 Shift+Command+P。
  2. 输入或选择命令。

编辑设置#

您可以使用设置编辑器查看和编辑您的用户和工作区设置。要在 Web IDE 中打开设置编辑器：

  • 在顶部菜单栏中，选择 文件 > 首选项 > 设置，或按 Command+,。

在设置编辑器中，您可以搜索要更改的设置。

编辑键盘快捷键#

您可以使用键盘快捷键编辑器查看和更改所有可用命令的默认键绑定。要在 Web IDE 中打开键盘快捷键编辑器：

  • 在顶部菜单栏中，选择 文件 > 首选项 > 键盘快捷键，或按 Command+K 然后 Command+S。

在键盘快捷键编辑器中，您可以搜索：

  • 您想要更改的键绑定
  • 您想要添加或移除键绑定的命令

键绑定基于您的键盘布局。如果您更改键盘布局，现有的键绑定会自动更新。

更改颜色主题#

您可以为 Web IDE 选择不同的颜色主题。默认主题是 极狐GitLab Dark。

要在 Web IDE 中更改颜色主题：

  1. 在顶部菜单栏中，选择 文件 > 首选项 > 主题 > 颜色主题，或按 Command+K 然后 Command+T。
  2. 从下拉列表中，使用箭头键预览主题。
  3. 选择一个主题。

Web IDE 会在您的 用户设置 中存储您的活动颜色主题。

配置同步设置#

要在 Web IDE 中配置同步设置：

  1. 按 Shift+Command+P。
  2. 在搜索框中输入 Settings Sync: Configure。
  3. 选择或清除复选框：
    • 设置
    • 键盘快捷键
    • 用户片段
    • 用户任务
    • UI 状态
    • 扩展
    • 配置文件

这些设置会在多个 Web IDE 实例之间自动同步。您无法同步用户配置文件或返回到同步设置的早期版本。

查看错过的通知#

当您在 Web IDE 中执行操作时，通知会出现在右下角。要查看您可能错过的任何通知：

  1. 在底部状态栏的右侧，选择铃铛图标 () 以查看通知列表。
  2. 选择您要查看的通知。

管理扩展#

  • Offering: JihuLab.com, 私有化部署
History
    • 引入于极狐GitLab 17.0，使用名为 web_ide_oauth 和 web_ide_extensions_marketplace 的功能标志。默认禁用。
    • 在极狐GitLab 17.4 中，web_ide_oauth 在 JihuLab.com 和私有化部署上启用。
    • 在极狐GitLab 17.4 中，web_ide_extensions_marketplace 在 JihuLab.com 上启用。
    • 在极狐GitLab 17.5 中，web_ide_oauth 被移除。
    • 引入于极狐GitLab 17.10，使用名为 vscode_extension_marketplace_settings 的功能标志。默认禁用。
    • 在极狐GitLab 17.11 中，web_ide_extensions_marketplace 和 vscode_extension_marketplace_settings 在私有化部署上启用。
此功能的可用性受控于功能标志。更多信息，可查看历史。

VS Code 扩展市场为您提供了增强 Web IDE 功能的扩展访问权限。默认情况下，极狐GitLab Web IDE 实例被配置为使用 Open VSX Registry。

在您可以管理和使用 Web IDE 中的扩展之前：

安装扩展#

要在 Web IDE 中安装扩展：

  1. 在顶部菜单栏中，选择 查看 > 扩展，或按 Command+Shift+X。
  2. 在搜索框中输入扩展名。
  3. 选择您要安装的扩展。
  4. 选择 安装。

卸载扩展#

要在 Web IDE 中卸载扩展：

  1. 在顶部菜单栏中，选择 查看 > 扩展，或按 Command+Shift+X。
  2. 从已安装扩展列表中，选择您要卸载的扩展。
  3. 选择 卸载。

扩展设置#

Web IDE 扩展可能需要额外的配置才能与您的项目一起工作。

使用 Vim 键绑定#

使用 Vim 键绑定，通过 Vim 文本编辑器的键盘快捷键导航和编辑文本。通过扩展市场，您可以将 Vim 键绑定添加到 Web IDE。

要启用 Vim 键绑定，请安装 Vim 扩展。有关更多信息，请参阅 安装扩展。

故障排除#

在使用 Web IDE 时，您可能会遇到以下问题。

输入时字符偏移#

在 Web IDE 中输入时，您可能会出现四个字符的偏移。作为一种变通方法：

  1. 在顶部菜单栏中，选择 文件 > 首选项 > 设置，或按 Command+,。
  2. 在右上角，选择 打开设置 (JSON)。
  3. 在 settings.json 文件中，添加 "editor.disableMonospaceOptimizations": true 或更改 "editor.fontFamily" 设置。

更新 OAuth 回调 URL#

  • Offering: 私有化部署

先决条件：

  • 您必须拥有实例的管理员访问权限。

Web IDE 使用 实例范围的 OAuth 应用 进行身份验证。如果 OAuth 回调 URL 配置错误，您可能会遇到 无法打开 Web IDE 错误页面，并显示以下消息：

plaintext
您用于访问 Web IDE 的 URL 和配置的 OAuth 回调 URL 不匹配。此问题通常发生在您使用代理时。

要解决此问题，您必须更新 OAuth 回调 URL 以匹配用于访问极狐GitLab 实例的 URL。

要更新 OAuth 回调 URL：

  1. 在左侧边栏的底部，选择 管理员。
  2. 选择 应用程序。
  3. 对于 极狐GitLab Web IDE，选择 编辑。
  4. 输入 OAuth 回调 URL。您可以输入由换行符分隔的多个 URL。

访问令牌的生命周期不能少于 5 分钟#

  • Offering: 极狐GitLab私有化部署

您可能会遇到一个错误消息，提示访问令牌的生命周期不能少于 5 分钟。

此错误发生在您的极狐GitLab 实例被配置为访问令牌过期时间少于 5 分钟时。Web IDE 需要至少 5 分钟生命周期的访问令牌才能正常工作。

要解决此问题，请在您的实例配置中将访问令牌生命周期增加到至少 5 分钟。有关配置访问令牌过期的更多信息，请参阅 访问令牌过期。

Workhorse 依赖#

  • Offering: 私有化部署

在极狐GitLab私有化部署中，Workhorse 必须安装并运行在极狐GitLab Rails 服务器的前面。否则，您可能会在打开 Web IDE 或使用某些功能（如 Markdown 预览）时遇到问题。

有关此依赖的更多信息，请参阅 依赖 Workhorse 的功能。