Web IDE

  • 在极狐 gitlab15.7中引入，功能标志为 vscode_web_ide。默认禁用。
  • 在 极狐SaaS 上启用于 15.7 版本。
  • 在私有化部署版上启用于 15.11 版本。
在私有化部署版上，此功能默认可用。要隐藏此功能，需要管理员禁用功能标志 vscode_web_ide。在 极狐SaaS 上，此功能可用。

Web IDE 是具有提交暂存功能的高级编辑器。 您可以使用 Web IDE 直接从极狐GitLab UI 更改多个文件。 有关更基本的实现，请参阅Web 编辑器。

打开 Web IDE

要从极狐GitLab UI 打开 Web IDE：

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

您还可以从以下位置打开 Web IDE：

  • 一个文件
  • 仓库文件列表
  • 合并请求

从文件或目录打开 Web IDE

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

从合并请求打开

从合并请求打开 Web IDE：

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

Web IDE 在单独的选项卡中打开新文件和修改后的文件，并与原始源代码并排显示更改。 为了优化加载时间，仅自动打开前 10 个文件（按更改的行数）。

左侧的 资源管理器 侧边栏会在新文件或修改过的文件旁边添加一个合并请求图标 ( )。 要查看文件的更改，右键点击文件并选择 与合并请求基准比较。

打开文件

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

  1. 按Command+P。
  2. 输入文件名。

搜索打开的文件

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

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

查看修改文件列表

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

  • 在左侧活动栏中，选择 源代码管理，或者按 Control+Shift+G。

您的 更改、暂存更改 和 合并更改 将显示在其中。 有关更多信息，请参见VS Code 文档。

恢复未提交的更改

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

如果您的未提交更改无法找到，您可以从本地历史记录中恢复更改。 要在 Web IDE 中恢复未提交的更改，请执行以下操作：

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

上传文件

要在 Web IDE 中上传文件，请执行以下操作：

  1. 在左侧活动栏中，选择 Explorer，或者按 Shift+Command+E。
  2. 转到要上传文件的目录。 要创建新目录：
    • 在左侧 Explorer 侧边栏中，右上角选择 New Folder ( )。
  3. 右键点击该目录并选择 Upload。
  4. 选择要上传的文件。

您可以一次上传多个文件。 文件将上传并自动添加到仓库中。

切换分支

Web IDE 默认使用当前分支。 要在 Web IDE 中切换分支，请执行以下操作：

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

创建分支

要在 Web IDE 中从当前分支创建新分支，请执行以下操作：

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

如果您没有仓库的写入权限，创建新分支 选项将不可见。

提交更改

要在 Web IDE 中提交更改，请执行以下操作：

  1. 在左侧活动栏中，选择 Source Control，或者按 Control+Shift+G。
  2. 输入您的提交消息。
  3. 提交到当前分支或创建新分支。

创建合并请求

要在 Web IDE 中创建合并请求，请执行以下操作：

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

有关更多信息，请参阅查看未读通知。

使用命令面板

您可以使用命令面板来访问许多命令。 要在 Web IDE 中打开命令面板并运行命令，请执行以下操作：

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

编辑设置

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

  • 在顶部菜单栏中，选择 File > Preferences > Settings，或者按 Command+,。

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

编辑键盘快捷键

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

  • 在顶部菜单栏中，选择 File > Preferences > Keyboard Shortcuts，或者按 Command+K 然后 Command+S。

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

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

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

更改颜色主题

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

要在Web IDE中更改颜色主题，请执行以下操作：

  1. 在顶部菜单栏中，选择 File > Preferences > Theme > Color Theme，或者按 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. 选择您要查看的通知。

扩展市场

  • 在极狐GitLab 17.0中作为beta功能引入，使用名为 web_ide_oauth 和 web_ide_extensions_marketplace 的功能标志，默认禁用。
  • 功能标志 web_ide_oauth 已在极狐saas、自管理上启用，功能标志 web_ide_extensions_marketplace 已在极狐saas上启用，功能标志 web_ide_oauth 于 GitLab 17.5 中移除。

功能标志： 此功能的可用性受功能标志的控制。

先决条件：

您可以使用扩展市场在 Web IDE 中下载和运行 VS Code 扩展。

扩展市场已为极狐GitLab实例预配置， 并硬编码为https://open-vsx.org/。

安装扩展

要在Web IDE中安装扩展，请执行以下操作：

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

卸载扩展

要在 Web IDE 中卸载扩展，请执行以下操作：

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

故障排除

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

输入时字符偏移

当您在Web IDE中输入时，可能会出现四个字符的偏移。 作为解决方法：

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

有关更多信息，请参见VS Code 问题 80170。

更新 OAuth 回调 URL

先决条件：

  • 您必须具有实例管理员权限。

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

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

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

要更新 OAuth 回调 URL，请执行以下操作：

  1. 在左侧边栏底部，选择 Admin。
  2. 选择 Applications。
  3. 对于 GitLab Web IDE，选择 Edit。
  4. 输入 OAuth 回调 URL。 您可以输入多个 URL，用换行符分隔。

Workhorse 依赖项

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

报告问题

要报告问题，请创建一个新议题，并提供以下信息：

  • 错误消息
  • 错误的详细信息
  • 问题发生的频率
  • 重现问题的步骤

如果您使用的是付费版，还可以联系支持获取帮助。