github / github/copilot-language-server-release

How should end users implement multiple edits provided by copilotInlineEdit?

Open
#32 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
290
Forks
24
PR merge metrics
No merged PRs in 30d

Description

In docs for copilot-language-server, there's the following excerpt:

> textDocument/copilotInlineEdit is a custom method used to retrieve "next edit" suggestions which are inline completions that may include deletions or modifications to existing text and may not be positioned at the cursor. These are similar to inline completions and the API shape is similar as well. But it is a separate method to allow opting into the feature and distinguishing between the two kinds of suggestions.
...
The result is an object containing an edits array:

Per the following, edits should be interpreted as alternatives to be cycled through, as defined in LSP spec:
https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#textDocument_inlineCompletion
> When multiple inline completion items are returned, the client may decide whether the user can cycle through them or if they, along with their filterText, are merely for filtering if the user continues to type without yet accepting the inline completion item.

I am curious though whether this is a correct interpretation or if e.g. contents of `edits` could instead be interpreted as a sequence of suggestions to be applied (well..) consecutively.

Contributor guide

Open the contributing guide

Research direction

Start with the copilot-language-server documentation excerpt and the linked LSP 3.18 inline-completion specification. Determine whether the edits array represents alternatives to cycle through or a sequence applied consecutively, then clarify that behavior in the documentation or API guidance. Confirm the wording matches the protocol's intended client behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.