Tracking lsp spec compliance (from version 3.3)

[lukel97]

EDITED by @jneira: we are gonna put here the main checklist of features to give it more visibility

3.3

• CompletionContext
• MarkupContent (done for Hover, still needed for some others) tracked by Support MarkdownClientCapabilities #329

3.11

• Add support for CodeActionOptions to allow a server to provide a list of code action it supports.

3.12

• Add support for textDocument/prepareRename request.

3.13

• File and folder operations (create, rename, move) to workspace edits.

3.14

• Signature label offsets.
• Location links.
• textDocument/declaration request.

3.15

• generic progress reporting.
• specific work done progress reporting support to requests where applicable.
• specific partial result progress support to requests where applicable.
• textDocument/selectionRange.
• server and client information.
• signature help context.
• add version on PublishDiagnosticsParams
• CodeAction#isPreferred.
• CompletionItem#tag.
• Diagnostic#tag.
• Add DocumentLink#tooltip support.
• Add trimTrailingWhitespace, insertFinalNewline and trimFinalNewlines to FormattingOptions.
• Add support for context in SignatureHelpRequest (noted by @bubba in Add support for context in SignatureHelpRequest #190)

3.16

• Call Hierarchy support, needed for Support for function call hierarchy haskell-language-server#738
• Semantic Token support. Tracked with Add support for semantic highlighting (LSP 3.16) #240, needed for Semantic tokens in HLS haskell-language-server#1654
• insert and replace ranges on CompletionItem
• diagnostic code descriptions
• tags on SymbolInformation and DocumentSymbol
• Monikers
• Linked editing
• Change annotation support for text edits and file operations
• Locale
• Diagnostic data
• MessageActionItem additional properties
• create/rename/delete notifications
• normalizesLineEndings
• Support for client default behavior on renames.

[theobat]

https://microsoft.github.io/language-server-protocol/specification#change-log

For tracking:

3.3

• Added support for CompletionContext
• Added support for MarkupContent (done for Hover, still needed for some others)

3.11

• Add support for CodeActionOptions to allow a server to provide a list of code action it supports.

3.12

• Add support for textDocument/prepareRename request.

3.13

• Add support for file and folder operations (create, rename, move) to workspace edits.

3.14

• Add support for signature label offsets.
• Add support for location links.
• Add support for textDocument/declaration request.

[EggBaconAndSpam]

I would love support for this one in particular:

3.13

* [ ]   Add support for file and folder operations (create, rename, move) to workspace edits.

[lukel97]

@EggBaconAndSpam I believe we are yet to add workspace support first. I think we have the types defined, but yes this would be a great feature to have! It might be nice to have a separate issue for this since there’s probably a lot of discussion needed around how the VFS/api will work around it, assuming that we’re adding deeper integration than just handlers.

[EggBaconAndSpam]

My use-case is the following: I would like to be able to create files via the "workspace/applyEdit" command; as far as I understand it workspaces as a concept are largely orthogonal to this feature. Currently the corresponding haskell-lsp-types definition only covers edits to existing files:

(From WorkspaceEdit.hs)

data WorkspaceEdit =
  WorkspaceEdit
    { _changes         :: Maybe WorkspaceEditMap
    , _documentChanges :: Maybe (List TextDocumentEdit)
    } deriving (Show, Read, Eq)

Which corresponds to documentChanges?: TextDocumentEdit[];, while the new spec extends this to documentChanges?: (TextDocumentEdit[] | (TextDocumentEdit | CreateFile | RenameFile | DeleteFile)[]);. I propose something along these lines:

data DocumentChange = DCEdit TextDocumentEdit
                    | DCCreate CreateFile
                    | DCRename RenameFile
                    | DCDelete DeleteFile


data WorkspaceEdit =
  WorkspaceEdit
    { _changes         :: Maybe WorkspaceEditMap
    , _documentChanges :: Maybe (List DocumentChange)
    } deriving (Show, Read, Eq)

[thomasjm]

I just made a pair of PRs for 3.11 and 3.12 support. They're not really adequately tested yet but hopefully this is a step in the right direction.

[jneira]

Updating @theobat tracking:

3.3

• CompletionContext
• MarkupContent (done for Hover, still needed for some others)

3.13

• File and folder operations (create, rename, move) to workspace edits.

3.14

• Signature label offsets.
• Location links.
• textDocument/declaration request.

3.15

• generic progress reporting.
• specific work done progress reporting support to requests where applicable.
• specific partial result progress support to requests where applicable.
• textDocument/selectionRange.
• server and client information.
• signature help context.
• add version on PublishDiagnosticsParams
• CodeAction#isPreferred.
• CompletionItem#tag.
• Diagnostic#tag.
• Add DocumentLink#tooltip support.
• Add trimTrailingWhitespace, insertFinalNewline and trimFinalNewlines to FormattingOptions.
• Add support for context in SignatureHelpRequest (noted by @bubba in Add support for context in SignatureHelpRequest #190)

3.16

• Call Hierarchy support, needed for New feature: call hierarchy support mpickering/ghcide#18
• Semantic Token support. Tracked with Add support for semantic highlighting (LSP 3.16) #240
• insert and replace ranges on CompletionItem
• diagnostic links
• tags on SymbolInformation and DocumentSymbol

Maybe some of 3.15 additions are already supported.