GitHub Copilot Language Server

When working with textDocument/copilotInlineEdit, follow these lifecycle steps:

1. Showing the edit: Since LSP does not provide an event for showing an edit, use the custom textDocument/didShowInlineEdit notification. Pass the item from the edits array (the command field is the required part of the item).
2. Acceptance: After a user accepts an edit, execute the provided command using workspace/executeCommand to ensure telemetry is recorded.
3. Discarding: If a provider result is discarded, use the github.copilot.didIgnoreNextEditSuggestionItem notification.

Reporting Cached Edits

If an edit includes a cacheTelemetryContext, it is an opaque string. When serving a cached copy:

• Create a fresh opportunityId locally for each serve.
• Do not reuse the source ID.
• When the occurrence ends, send a textDocument/reportCachedInlineEdit notification.

Note: For results that are never rendered, send isShown: false and acceptance: "notAccepted" via the reporting notification.

// textDocument/didShowInlineEdit
{
    "item": {
        "command": {
            "arguments": ["some-id"]
        }
    }
}

// textDocument/reportCachedInlineEdit
{
    "opportunityId": "unique-id-for-this-cache-serve",
    "context": "<unchanged cacheTelemetryContext from the source edit>",
    "isShown": true,
    "acceptance": "accepted"
}

The server uses a draft version of the LSP textDocument/inlineCompletion request to provide "ghost text" suggestions.

Requesting Completions

Clients send a request containing the document URI, version, position, and formattingOptions.

Handling Results

The response contains an items array. Each item includes insertText, a range, and a command used for acceptance telemetry.

Completion Lifecycle

1. Show Completion: Call the custom textDocument/didShowCompletion notification when the suggestion is displayed.
2. Accept Completion: When the user accepts a suggestion, call workspace/executeCommand using the command from the completion item.
3. Partial Acceptance: If the user accepts only part of the suggestion, send textDocument/didPartiallyAcceptCompletion. The acceptedLength must be the total length in UTF-16 codepoints from the start of insertText to the end of the accepted text.

{
    "textDocument": {
        "uri": "file:///path/to/file",
        "version": 0
    },
    "position": {"line": 1, "character": 2},
    "context": {
        "triggerKind": 2
    },
    "formattingOptions": {
        "tabSize": 4,
        "insertSpaces": true
    }
}

The textDocument/copilotInlineEdit method retrieves "next edit" suggestions. These are inline completions that may include deletions or modifications to existing text and are not necessarily positioned at the cursor. This is a separate method from standard inline completions to allow for feature opting and distinction.

Request Parameters

The request uses parameters similar to TextDocumentPositionParams but requires a textDocument.version field (a VersionedTextDocumentIdentifier).

Response Format

The response contains an edits array. Each edit includes a command object. To trigger acceptance telemetry, the client must call the command via workspace/executeCommand after the user accepts the edit.

// Request
{
    "textDocument": {
        "uri": "file:///path/to/file",
        "version": 0
    },
    "position": {"line": 1, "character": 2}
}

// Response
{
    "edits": [
        {
            "text": "an edit suggestion",
            "textDocument": {
                "uri": "file:///path/to/file",
                "version": 0
            },
            "range": {
                "start": {"line": 1, "character": 0},
                "end": {"line": 1, "character": 5}
            },
            "command": {
                "title": "Accept inline edit",
                "command": "github.copilot.didAcceptCompletionItem",
                "arguments": ["some-id"]
            }
        }
    ]
}