VS Code 设置中的 GitHub Copilot 参考
本文列出了在Visual Studio Code中GitHub Copilot的配置设置。有关在VS Code中使用设置的一般信息,请参阅用户和工作区设置,以及变量参考以获取有关预定义变量支持的信息。
Tip
如果您还没有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.chat.followUps: 控制 Copilot 是否应在聊天中建议后续问题。
- github.copilot.chat.localeOverride: 指定Copilot应使用的语言环境,例如
en
或fr
。 - 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.editing.confirmEditRequestRemoval - 在撤销编辑之前请求确认(默认值:
true
) - chat.editing.confirmEditRequestRetry - 在执行最后一次编辑的重做之前请求确认(默认值:
true
) - chat.editing.alwaysSaveWithGeneratedChanges - 自动将 Copilot 编辑生成的更改保存到磁盘(默认值:
false
)
内联聊天设置
- inlineChat.acceptedOrDiscardBeforeSave: 控制编辑器中的待处理内联聊天会话是否阻止保存文件。
- inlineChat.finishOnType: 当在更改区域外输入时是否结束内联聊天会话。
- inlineChat.holdToSpeech: 是否按住内联聊天快捷键将自动启用语音识别。
- inlineChat.inlineChat.lineEmptyHint : 控制是否在空行上显示内联聊天的提示。
- inlineChat.mode: 配置使用内联聊天生成的更改是直接应用于文档还是先进行预览。
- inlineChat.lineNaturalLanguageHint : 实验性建议,当一行主要由单词组成时,立即触发内联聊天。
- github.copilot.chat.temporalContext.enabled : 是否在Inline Chat中与Copilot请求一起包含最近查看和编辑的文件。
自定义Copilot提示
- github.copilot.chat.codeGeneration.instructions : 一组将添加到生成代码的Copilot请求中的指令。
- github.copilot.chat.codeGeneration.useInstructionFiles (预览): 控制是否将来自
.github/copilot-instructions.md
的代码指令添加到 Copilot 请求中。 - github.copilot.chat.testGeneration.instructions : 一组将添加到生成测试的Copilot请求中的指令。
- github.copilot.chat.reviewSelection.instructions (预览): 一组指令,将添加到Copilot请求中,用于审查当前编辑器选择的内容。
- github.copilot.chat.commitMessageGeneration.instructions : 一组将添加到生成提交消息的Copilot请求中的指令。
调试设置
测试设置
- github.copilot.chat.generateTests.codeLens : 显示生成测试代码镜头,用于当前测试覆盖率信息未覆盖的符号。
- github.copilot.chat.setupTests.enabled : 启用实验性的
/setupTests
意图和在/tests
生成中的提示。 - github.copilot.chat.fixTestFailure.enabled: 启用聊天中的预览
/fixTestFailure
意图,并在未找到测试设置时自动委托某些/fix
调用。 - github.copilot.chat.testGeneration.instructions : 一组将添加到生成测试的Copilot请求中的指令。
笔记本设置
无障碍设置
- 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: 语音识别在你停止说话后保持活动的持续时间(以毫秒为单位)。