🚀 在 VS Code 中

GitHub Copilot 在 VS Code 设置参考

本文列出了 Visual Studio Code 中 GitHub Copilot 的配置设置。有关在 VS Code 中使用设置的常规信息,请参阅用户和工作区设置,以及变量参考,以获取有关预定义变量支持的信息。

提示

如果您还没有 Copilot 订阅,您可以通过注册Copilot 免费计划来免费使用 Copilot,并获得每月有限次数的补全和聊天互动。

团队正在不断努力改进 VS Code 中的 Copilot 并添加新功能。某些功能仍处于实验阶段。请试用它们并在我们的问题中分享您的反馈。获取有关 VS Code 中的功能生命周期的更多信息。

常规设置

  • github.copilot.editor.enableAutoCompletions:自动显示内联补全。
  • github.copilot.enable:为指定的语言启用或禁用 Copilot 补全。
  • github.copilot.editor.enableCodeActions:控制 Copilot 命令在可用时是否显示为代码操作。
  • github.copilot.renameSuggestions.triggerAutomatically:控制 Copilot 是否自动生成重命名建议。
  • chat.commandCenter.enabled (实验性):控制命令中心是否显示聊天操作菜单。
  • workbench.commandPalette.experimental.askChatLocation (实验性):控制命令面板应在何处询问聊天问题。
  • github.copilot.chat.search.semanticTextResults (实验性):在搜索视图中启用语义搜索结果。
  • github.copilot.nextEditSuggestions.enabled (预览):启用 Copilot Next Edit Suggestions (Copilot NES) (预览)
  • editor.inlineSuggest.edits.codeShifting:配置 Copilot NES 是否能够移动您的代码以显示建议。
  • editor.inlineSuggest.edits.renderSideBySide:配置 Copilot NES 是否可以并排显示较大的建议(如果可能),或者 Copilot NES 是否应始终在相关代码下方显示较大的建议。

聊天设置

  • github.copilot.chat.codesearch.enabled (预览):在提示中使用 #codebase 时,Copilot 会自动发现要编辑的相关文件。
  • github.copilot.chat.followUps:控制 Copilot 是否应在聊天中建议后续问题。
  • github.copilot.chat.localeOverride:指定 Copilot 应以哪种语言进行响应,例如 enfr
  • github.copilot.chat.runCommand.enabled:在聊天视图中启用 /runCommand 意图以运行 VS Code 命令。
  • github.copilot.chat.useProjectTemplates:使用 /new 时,使用相关的 GitHub 项目作为起始项目。
  • github.copilot.chat.scopeSelection:如果您使用 /explain 并且活动编辑器没有选择内容,是否提示指定符号范围。
  • github.copilot.chat.terminalChatLocation:控制应在何处打开来自终端的聊天查询。
  • chat.experimental.detectParticipant.enabled (实验性):在聊天视图中启用聊天参与者检测。
  • chat.editor.fontFamily:聊天代码块中的字体系列。
  • chat.editor.fontSize:聊天代码块中的字体大小(像素)。
  • chat.editor.fontWeight:聊天代码块中的字体粗细。
  • chat.editor.lineHeight:聊天代码块中的行高(像素)。
  • chat.editor.wordWrap:切换聊天代码块中的行自动换行。
  • chat.implicitContext.enabled (预览) - 配置是否应将活动编辑器自动添加为聊天提示的上下文。

Copilot 编辑设置

  • chat.editing.confirmEditRequestRemoval - 在撤消编辑之前请求确认(默认值:true
  • chat.editing.confirmEditRequestRetry - 在执行上次编辑的重做之前请求确认(默认值:true
  • github.copilot.chat.edits.temporalContext.enabled (实验性):是否在 Copilot 编辑中的请求中包含最近查看和编辑过的文件。
  • github.copilot.chat.codesearch.enabled (预览):在提示中使用 #codebase 时,Copilot 会自动发现要编辑的相关文件。
  • chat.editing.alwaysSaveWithGeneratedChanges - 自动将 Copilot 编辑生成的更改保存到磁盘(默认值:false
  • chat.implicitContext.enabled (预览) - 配置是否应将活动编辑器自动添加为聊天提示的上下文。
  • chat.editing.autoAcceptDelay - 配置自动接受建议的编辑之前的延迟时间,使用零禁用自动接受(默认值:0)
  • chat.agent.maxRequests - Copilot 编辑在代理模式下可以发出的最大请求数(默认值:15)
  • github.copilot.chat.edits.suggestRelatedFilesFromGitHistory(实验性) - 在 Copilot 编辑中建议来自 git 历史记录的相关文件(默认值:false
  • github.copilot.chat.agent.runTasks - 在 Copilot 编辑中使用代理模式时运行工作区任务(默认值:true

内联聊天设置

  • inlineChat.acceptedOrDiscardBeforeSave:控制编辑器中挂起的内联聊天会话是否阻止保存文件。
  • inlineChat.finishOnType:是否在更改区域外键入时完成内联聊天会话。
  • inlineChat.holdToSpeech:是否按住内联聊天键盘快捷键将自动启用语音识别。
  • inlineChat.inlineChat.lineEmptyHint (实验性):控制是否在空行上显示内联聊天的提示。
  • inlineChat.lineNaturalLanguageHint (实验性):实验性建议,一旦某行主要由单词组成,就会触发内联聊天。
  • github.copilot.chat.editor.temporalContext.enabled (实验性):是否在内联聊天中的 Copilot 请求中包含最近查看和编辑过的文件。

自定义 Copilot 提示

  • github.copilot.chat.codeGeneration.useInstructionFiles:控制是否将来自 .github/copilot-instructions.md 的代码指令添加到 Copilot 请求中。
  • github.copilot.chat.codeGeneration.instructions (实验性):一组将添加到生成代码的 Copilot 请求中的指令。
  • github.copilot.chat.testGeneration.instructions (实验性):一组将添加到生成测试的 Copilot 请求中的指令。
  • github.copilot.chat.reviewSelection.instructions (预览):一组将添加到 Copilot 请求中,用于审查当前编辑器选择内容的指令。
  • github.copilot.chat.commitMessageGeneration.instructions (实验性):一组将添加到生成提交消息的 Copilot 请求中的指令。用于审查当前编辑器选择内容的 Copilot 请求。
  • github.copilot.chat.pullRequestDescriptionGeneration.instructions (实验性):一组将添加到生成拉取请求标题和描述的 Copilot 请求中的指令。
  • chat.promptFiles (实验性):启用提示文件并指定提示文件文件夹。设置为 true 以使用默认位置 (.github/prompts),或使用 { "/path/to/folder": boolean } 表示法指定不同的路径。相对路径从工作区的根文件夹解析。

调试设置

  • github.copilot.chat.startDebugging.enabled (预览):在聊天视图中启用实验性的 /startDebugging 意图以生成调试配置。

测试设置

  • github.copilot.chat.generateTests.codeLens (实验性):为当前测试覆盖率信息未涵盖的符号显示生成测试代码镜头。
  • github.copilot.chat.setupTests.enabled (实验性):在 /tests 生成中启用实验性的 /setupTests 意图和提示。
  • github.copilot.chat.fixTestFailure.enabled:启用聊天中的预览 /fixTestFailure 意图,并在未找到测试设置时自动委派某些 /fix 调用。
  • github.copilot.chat.testGeneration.instructions (实验性):一组将添加到生成测试的 Copilot 请求中的指令。

Notebook 设置

  • notebook.experimental.generate (实验性):启用生成操作,以在 Notebook 编辑器中创建启用内联聊天的代码单元格。

辅助功能设置

  • inlineChat.accessibleDiffView:内联聊天是否也为其更改呈现可访问的差异查看器。
  • accessibility.signals.chatRequestSent:在发出聊天请求时播放信号 - 声音(音频提示)和/或公告(警报)。
  • accessibility.signals.chatResponseReceived:在收到响应时播放声音/音频提示。
  • accessibility.verbosity.inlineChat:提供有关如何访问内联编辑器聊天辅助功能帮助菜单的信息,并在输入获得焦点时使用提示警报描述如何使用该功能。
  • accessibility.verbosity.inlineCompletions:提供有关如何访问内联补全悬停和辅助功能视图的信息。
  • accessibility.verbosity.panelChat:在聊天输入获得焦点时,提供有关如何访问聊天帮助菜单的信息。
  • accessibility.voice.keywordActivation:控制是否识别关键字短语“Hey Code”以启动语音聊天会话。
  • accessibility.voice.autoSynthesize:控制当使用语音作为输入时,是否应自动朗读文本响应。
  • accessibility.voice.speechTimeout:语音识别在您停止说话后保持活动状态的持续时间(以毫秒为单位)。