-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Copilot settings page and feature lifecycle (#7689)
* Add feature lifecycle section * Add Copilot settings page * Update issues link * Update after review
- Loading branch information
Showing
4 changed files
with
109 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| Order: 11 | ||
| Area: copilot | ||
| TOCTitle: Settings Reference | ||
| ContentId: 7b232695-cbbe-4f3f-a625-abc7a5e6496c | ||
| PageTitle: GitHub Copilot in VS Code settings reference | ||
| DateApproved: 10/03/2024 | ||
| MetaDescription: Overview of the configuration settings for GitHub Copilot in Visual Studio Code. | ||
| MetaSocialImage: images/shared/github-copilot-social.png | ||
| --- | ||
| # GitHub Copilot in VS Code settings reference | ||
|
|
||
| This article lists the configuration settings for GitHub Copilot in Visual Studio Code. For general information about working with settings in VS Code, refer to [User and workspace settings](/docs/getstarted/settings.md), as well as the [Variables reference](/docs/editor/variables-reference.md) for information about predefined variable support. | ||
|
|
||
| The team is continuously working on improving Copilot in VS Code and adding new features. Items marked with <i class="codicon codicon-beaker"></i> are experimental features. Try them out and share your feedback in [our issues](https://github.com/microsoft/vscode-copilot-release/issues). Get more info about the [feature lifecycle in VS Code](/docs/getstarted/settings.md#feature-lifecycle). | ||
|
|
||
| ## General settings | ||
|
|
||
| | Setting | Default | Description | | ||
| |--------|----------|-------------| | ||
| | `setting(github.copilot.editor.enableAutoCompletions)` | true | Automatically show inline completions. | | ||
| | `setting(github.copilot.enable)` | `{"*": true, "plaintext": false, "markdown": false, "scminput": false }` | Enable or disable Copilot completions for specified [languages](/docs/languages/identifiers.md). | | ||
| | `setting(github.copilot.editor.enableCodeActions)` | true | Controls if Copilot commands are shown as Code Actions when available. | | ||
| | `setting(github.copilot.renameSuggestions.triggerAutomatically)` | true | Controls wether Copilot generates suggestions for renaming. | | ||
| | `setting(chat.commandCenter.enabled)` <i class="codicon codicon-beaker"></i> | true | Controls whether the command center shows a menu for chat actions. | | ||
| | `setting(workbench.commandPalette.experimental.askChatLocation)` <i class="codicon codicon-beaker"></i> | `chatView` | Controls where the Command Palette should ask chat questions. | | ||
| | `setting(github.copilot.chat.search.semanticTextResults)` _(Preview)_ | false | Enables semantic search results in the Search view. | | ||
|
|
||
| ## Chat settings | ||
|
|
||
| | Setting | Default | Description | | ||
| |--------|----------|-------------| | ||
| | `setting(chat.editor.fontFamily)` | `default` | Font family in chat codeblocks. | | ||
| | `setting(chat.editor.fontSize)` | 14 | Font size in pixels in chat codeblocks. | | ||
| | `setting(chat.editor.fontWeight)` | `default` | Font weight in chat codeblocks. | | ||
| | `setting(chat.editor.lineHeight)` | 0 | Line height in pixels in chat codeblocks - use 0 to compute the line height from the font size. | | ||
| | `setting(chat.editor.wordWrap)` | `off` | Configure line wrapping in chat codeblocks. | | ||
| | `setting(github.copilot.chat.localeOverride)` | `auto` (current display language) | Specify a locale that Copilot should respond in, such as `en` or `fr`. | | ||
| | `setting(github.copilot.chat.fixTestFailure.enabled)` | true | Enables the preview `/fixTestFailure` intent in chat and delegates certain `/fix` invocations automatically if no testing setup is found. | | ||
| | `setting(github.copilot.chat.runCommand.enabled)` | true | Enables the `/runCommand` intent in the Chat view to run VS Code commands. | | ||
| | `setting(github.copilot.chat.useProjectTemplates)` | true | Use relevant GitHub projects as starter projects when using `/new`. | | ||
| | `setting(github.copilot.chat.terminalChatLocation)` | `chatView` | Controls where chat queries from the terminal should be opened. | | ||
| | `setting(github.copilot.chat.scopeSelection)` | false | Whether to prompt the user to select a specific symbol scope if the user uses `/explain` and the active editor has no selection. | | ||
| | `setting(github.copilot.chat.experimental.codeFeedback.instructions)` <i class="codicon codicon-beaker"></i> | `[]` | A set of instructions that will be added to Copilot requests that provide feedback for code. | | ||
| | `setting(github.copilot.chat.experimental.codeGeneration.instructions)` <i class="codicon codicon-beaker"></i> | `[]` | A set of instructions that will be added to Copilot requests that generate code. | | ||
| | `setting(github.copilot.chat.experimental.testGeneration.instructions)` <i class="codicon codicon-beaker"></i> | `[]` | A set of instructions that will be added to Copilot requests that generate tests. | | ||
| | `setting(github.copilot.chat.experimental.codeGeneration.useInstructionFiles)` <i class="codicon codicon-beaker"></i> | false | Controls wether code instructions from `.github/copilot-instructions.md` are added to Copilot requests. | | ||
| | `setting(github.copilot.chat.experimental.generateTests.codeLens)` <i class="codicon codicon-beaker"></i> | false | Show **Generate tests** code lens for symbols that are not covered by current test coverage information. | | ||
| | `setting(github.copilot.chat.experimental.inlineChatCompletionTrigger.enabled)` <i class="codicon codicon-beaker"></i> | false | Experimental suggestion that triggers inline chat as soon as a line mostly consists of words. | | ||
| | `setting(github.copilot.chat.experimental.inlineChatHint.enabled)` <i class="codicon codicon-beaker"></i> | false | Hint for inline chat that shows once a line mostly consists of words. | | ||
| | `setting(github.copilot.chat.experimental.setupTests.enabled)` <i class="codicon codicon-beaker"></i> | true | Enables the experimental `/setupTests` intent and prompting in `/tests` generation. | | ||
| | `setting(github.copilot.chat.experimental.startDebugging.enabled)` <i class="codicon codicon-beaker"></i> | true | Enables the experimental `/startDebugging` intent in the Chat view to generate debugging configuration. | | ||
| | `setting(github.copilot.chat.experimental.temporalContext.enabled)` <i class="codicon codicon-beaker"></i> | false | Whether to include recently viewed and edited files with Copilot requests in inline chat. | | ||
| | `setting(chat.experimental.detectParticipant.enabled)` <i class="codicon codicon-beaker"></i> | false | Enable chat participant detection in the Chat view. | | ||
|
|
||
| ## Inline chat settings | ||
|
|
||
| | Setting | Default | Description | | ||
| |--------|----------|-------------| | ||
| | `setting(inlineChat.acceptedOrDiscardBeforeSave)` | true | Controls whether pending inline chat sessions in an editor prevent saving the file. | | ||
| | `setting(inlineChat.finishOnType)` | `off` | Whether to finish an inline chat session when typing outside of changed regions. | | ||
| | `setting(inlineChat.holdToSpeech)` | true | Whether holding the inline chat keybinding will automatically enable speech recognition. | | ||
| | `setting(inlineChat.mode)` | `live` | Configure if changes crafted with inline chat are applied directly to the document or are previewed first. | | ||
|
|
||
| ## Notebook settings | ||
|
|
||
| | Setting | Default | Description | | ||
| |--------|----------|-------------| | ||
| | `setting(notebook.experimental.generate)` <i class="codicon codicon-beaker"></i> | true | Enable the **Generate** action to create code cells with inline chat enabled in the notebook editor. | | ||
|
|
||
| ## Accessibility settings | ||
|
|
||
| | Setting | Default | Description | | ||
| |--------|----------|-------------| | ||
| | `setting(inlineChat.accessibleDiffView)` | `auto` | Whether the inline chat also renders an accessible diff viewer for its changes. | | ||
| | `setting(accessibility.signals.chatRequestSent)` | `{ "sound": "auto", "announcement": "auto" }` | Plays a signal - sound (audio cue) and/or announcement (alert) - when a chat request is made. | | ||
| | `setting(accessibility.signals.chatResponseReceived)` | `{ "sound": "auto" }` | Plays a sound / audio cue when the response has been received. | | ||
| | `setting(accessibility.verbosity.inlineChat)` | true | Provide information about how to access the inline editor chat accessibility help menu and alert with hints that describe how to use the feature when the input is focused. | | ||
| | `setting(accessibility.verbosity.inlineCompletions)` | true | Provide information about how to access the inline completions hover and Accessible View. | | ||
| | `setting(accessibility.verbosity.panelChat)` | true | Provide information about how to access the chat help menu when the chat input is focused. | | ||
| | `setting(accessibility.voice.keywordActivation)` | `off` | Controls whether the keyword phrase 'Hey Code' is recognized to start a voice chat session. | | ||
| | `setting(accessibility.voice.autoSynthesize)` | `off` | Controls whether a textual response should automatically be read out aloud when speech was used as input. | | ||
| | `setting(accessibility.voice.speechTimeout)` | 1200 | The duration in milliseconds that voice speech recognition remains active after you stop speaking. | | ||
|
|
||
| ## Related resources | ||
|
|
||
| * [Get a quick overview of the Copilot features in VS Code](/docs/copilot/copilot-vscode-features.md) |
3 changes: 3 additions & 0 deletions
3
docs/getstarted/images/settings/settings-editor-experimental.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters