Help us learn about your current experience with the documentation. Take the survey.

设置代码建议

您可以在多种不同的 IDE 中使用代码建议。 要设置代码建议,请按照您 IDE 的说明进行操作。

前提条件

要使用代码建议,您需要:

  • GitLab Duo Core、Pro 或 Enterprise 插件。
  • Premium 或 Ultimate 订阅。
  • 如果您有 GitLab Duo Pro 或 Enterprise,则需要分配席位。
  • 如果您有 GitLab Duo Core,请开启 IDE 功能
  • 确认代码建议 支持您使用的语言。 不同的 IDE 支持不同的语言。

配置编辑器扩展

代码建议是编辑器扩展的一部分。要使用代码建议:

  1. 在您的 IDE 中安装扩展。
  2. 从 IDE 身份验证 GitLab。您可以使用 OAuth 或个人访问令牌。
  3. 配置扩展。

按照以下步骤为您的 IDE 进行操作:

启用代码建议

如果您满足 前提条件,代码建议将自动启用。 要确认,请打开您的 IDE 并验证代码建议是否正常工作。

VS Code

要验证 VS Code 中是否启用了代码建议:

  1. 在 VS Code 中,转到 设置 > 扩展 > GitLab 工作流
  2. 选择 管理 ( settings )。
  3. 确保 GitLab › Duo 代码建议:已启用 已被选中。
  4. 可选。对于 GitLab › Duo 代码建议:已启用的支持语言, 选择您想要提供建议或生成代码的语言。
  5. 可选。对于 GitLab › Duo 代码建议:其他语言,添加您想要使用的其他语言。

Visual Studio

要验证 Visual Studio 中是否启用了代码建议:

  1. 在 Visual Studio 中,在底部状态栏上,将鼠标悬停在 GitLab 图标上。
  2. 当代码建议启用时,图标工具提示会显示 GitLab code suggestions are enabled.
  3. 如果代码建议未启用,请在顶部栏选择 扩展 > GitLab > 切换代码建议 来启用它。

JetBrains IDEs

要验证 JetBrains IDEs 中是否启用了代码建议:

  1. 在您的 IDE 中,在顶部栏选择您的 IDE 名称,然后选择 设置
  2. 在左侧边栏中,展开 工具,然后选择 GitLab Duo
  3. 功能 部分,确保 启用代码建议启用 GitLab Duo 聊天 已被选中。
  4. 选择 确定保存

为代码建议添加自定义证书

GitLab Duo 尝试检测 受信任的根证书, 而无需您进行配置。如果需要,请配置您的 JetBrains IDE 以允许 GitLab Duo 插件 在连接到您的 GitLab 实例时使用自定义 SSL 证书。

要将自定义 SSL 证书与 GitLab Duo 一起使用:

  1. 在您的 IDE 中,在顶部栏选择您的 IDE 名称,然后选择 设置
  2. 在左侧边栏中,展开 工具,然后选择 GitLab Duo
  3. 连接 下,输入 GitLab 实例 URL
  4. 要验证您的连接,选择 验证设置
  5. 选择 确定保存

如果您的 IDE 检测到不受信任的 SSL 证书:

  1. GitLab Duo 插件会显示一个确认对话框。
  2. 查看显示的 SSL 证书详细信息。
    • 确保证书详细信息与您在浏览器中连接到 GitLab 时显示的证书匹配。
  3. 如果证书符合您的预期,选择 接受

要查看您已接受的证书:

  1. 在您的 IDE 中,在顶部栏选择您的 IDE 名称,然后选择 设置
  2. 在左侧边栏中,选择 工具 > 服务器证书
  3. 选择 服务器证书
  4. 选择一个证书以查看它。

Eclipse

要启用 GitLab Duo 代码建议,请打开一个 Eclipse 项目。如果您只打开单个文件,代码建议将禁用所有文件类型。

要验证 Eclipse 中是否启用了代码建议:

  1. 在 Eclipse 中,打开您的 GitLab 项目。
  2. 在 Eclipse 底部工具栏中,选择 GitLab 图标。

代码建议 显示为 “已启用”。

Neovim

代码建议提供了一个 LSP(语言服务器协议)服务器,以支持内置的 Control+xControl+o Omni 完成键映射:

模式 键映射 类型 描述
INSERT Control+x, Control+o 内置 通过语言服务器请求来自 GitLab Duo 代码建议的完成。
NORMAL <Plug>(GitLabToggleCodeSuggestions) <Plug> 为当前缓冲区切换代码建议的开启或关闭。需要 配置

验证代码建议是否已启用

来自 GitLab 的所有编辑器扩展(Neovim 除外)都会向您的 IDE 状态栏添加一个图标。 例如,在 Visual Studio 中:

Visual Studio 中的状态栏。

图标 状态 含义
tanuki-ai 就绪 您已配置并启用了 GitLab Duo,并且您使用的语言支持代码建议。
tanuki-ai-off 未配置 您尚未输入个人访问令牌,或者您使用的语言不支持代码建议。
获取代码建议的状态图标。 正在加载建议 GitLab Duo 正在为您获取代码建议。
代码建议错误的状态图标。 错误 GitLab Duo 遇到了错误。

关闭代码建议

关闭代码建议的过程因 IDE 而异。

您不能单独关闭代码生成和代码补全。

VS Code

要在 VS Code 中关闭代码建议:

  1. 转到 代码 > 设置 > 扩展
  2. 选择 管理 ( settings ) > 设置
  3. 取消选中 GitLab Duo 代码建议 复选框。

或者,您可以在 VS Code 的 settings.json 文件中 gitlab.duoCodeSuggestions.enabled 设置为 false

Visual Studio

要在不卸载扩展的情况下打开或关闭代码建议, GitLab.ToggleCodeSuggestions 自定义命令分配键盘快捷键

要禁用或卸载扩展,请参阅 Microsoft Visual Studio 文档中关于卸载或禁用扩展的内容

JetBrains IDEs

禁用 GitLab Duo(包括代码建议)的过程是相同的, 无论您使用的是哪个 JetBrains IDE。

  1. 在您的 JetBrains IDE 中,转到设置并选择插件菜单。
  2. 在已安装的插件下,找到 GitLab Duo 插件。
  3. 禁用该插件。

有关更多信息,请参阅 JetBrains 产品文档

Eclipse

要禁用项目的 Eclipse 代码建议:

  1. 在 Eclipse 底部工具栏中,选择 GitLab 图标。
  2. 选择 禁用代码建议 以禁用当前项目的代码建议。

要禁用特定语言的 Eclipse 代码建议:

  1. 在 Eclipse 底部工具栏中,选择 GitLab 图标。
  2. 选择 显示设置
  3. 向下滚动到 代码建议启用的语言 部分,并清除您想要禁用的语言的复选框。

Neovim

  1. 转到 Neovim defaults.lua 设置文件

  2. code_suggestions 下,将 enabled = 标志更改为 false

    code_suggestions = {
    ...
     enabled = false,

关闭 GitLab Duo

或者,您可以 关闭 GitLab Duo(包括代码建议), 完全为组、项目或实例关闭。