language-servers/language-server-protocol
1
0
Fork 0
mirror of https://github.com/microsoft/language-server-protocol.git synced 2025-12-23 08:48:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge f0a6a9e814 into f1b5515dd9

Browse source
This commit is contained in:
Alan Donovan 2025-12-11 14:29:20 +03:00 • committed by GitHub
commit e0cfedf804
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

21
_specifications/lsp/3.18/types/textDocumentPositionParams.md
View file

@ -2,7 +2,18 @@
Was `TextDocumentPosition` in 1.0 with inlined parameters.
A parameter literal used in requests to pass a text document and a position inside that document. It is up to the client to decide how a selection is converted into a position when issuing a request for a text document. The client can, for example, honor or ignore the selection direction to make LSP request consistent with features implemented internally.
A parameter literal used in requests to pass a text document and a
position or optional range within that document.
To be consistent with features implemented internally, the client is
free to choose for each LSP request how a cursor position or text
selection is converted into a position or range.
For example, some editors display the cursor as a caret at the current
insertion point between characters (`A|BC`), whereas others display it
as a box around the character after the insertion point (`A🄱C`).
Depending on the operation, in the absence of a selection range,
editors of the second kind may choose to interpret the cursor position
as an implicit selection of the character _after_ the position.
```typescript
interface TextDocumentPositionParams {
@ -12,8 +23,14 @@ interface TextDocumentPositionParams {
textDocument: TextDocumentIdentifier;
/**
* The position inside the text document.
* The cursor position within the text document.
*/
position: Position;
/**
* The selected range within the text document, if any.
* The position is typically one of the endpoints of the range.
*/
range?: Range;
}
```