WIP8

Signed-off-by: Koichi Shiraishi <[email protected]>

Author: zchee

protocol/basic.go

@@ -401,7 +401,7 @@ type WorkspaceEdit struct {
 
 	// DocumentChanges depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes are
 	// either an array of `TextDocumentEdit`s to express changes to n different text documents where each text document edit addresses a specific version of a text document. Or it can contain above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations. Whether a client supports versioned document edits is expressed via `workspace.workspaceEdit.documentChanges` client capability. If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then only plain `TextEdit`s using the `changes` property are supported.
-	DocumentChanges WorkspaceEditDocumentChanges `json:"documentChanges,omitempty"`
+	DocumentChanges *WorkspaceEditDocumentChanges `json:"documentChanges,omitempty"`
 
 	// ChangeAnnotations a map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and delete file / folder operations. Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.
 	ChangeAnnotations map[ChangeAnnotationIdentifier]ChangeAnnotation `json:"changeAnnotations,omitempty"`
@@ -463,7 +463,7 @@ type Diagnostic struct {
 	Severity DiagnosticSeverity `json:"severity,omitempty"`
 
 	// Code the diagnostic's code, which usually appear in the user interface.
-	Code DiagnosticCode `json:"code,omitempty"`
+	Code *DiagnosticCode `json:"code,omitempty"`
 
 	// CodeDescription an optional property to describe the error code. Requires the code field (above) to be present/not null.
 	CodeDescription *CodeDescription `json:"codeDescription,omitempty"`

protocol/client_interface.go

@@ -12,25 +12,25 @@ import (
 const (
 	MethodClientCancelRequest                 ClientMethod = "$/cancelRequest"                       // bidirect client notification
 	MethodClientProgress                      ClientMethod = "$/progress"                            // bidirect client notification
-	MethodWindowLogMessage                    ClientMethod = "window/logMessage"                     // client notification
 	MethodLogTrace                            ClientMethod = "$/logTrace"                            // client notification
+	MethodTelemetryEvent                      ClientMethod = "telemetry/event"                       // client notification
 	MethodTextDocumentPublishDiagnostics      ClientMethod = "textDocument/publishDiagnostics"       // client notification
+	MethodWindowLogMessage                    ClientMethod = "window/logMessage"                     // client notification
 	MethodWindowShowMessage                   ClientMethod = "window/showMessage"                    // client notification
-	MethodTelemetryEvent                      ClientMethod = "telemetry/event"                       // client notification
+	MethodClientRegisterCapability            ClientMethod = "client/registerCapability"             // client request
+	MethodClientUnregisterCapability          ClientMethod = "client/unregisterCapability"           // client request
+	MethodWindowShowDocument                  ClientMethod = "window/showDocument"                   // client request
+	MethodWindowShowMessageRequest            ClientMethod = "window/showMessageRequest"             // client request
+	MethodWindowWorkDoneProgressCreate        ClientMethod = "window/workDoneProgress/create"        // client request
 	MethodWorkspaceApplyEdit                  ClientMethod = "workspace/applyEdit"                   // client request
 	MethodWorkspaceCodeLensRefresh            ClientMethod = "workspace/codeLens/refresh"            // client request
 	MethodWorkspaceConfiguration              ClientMethod = "workspace/configuration"               // client request
 	MethodWorkspaceDiagnosticRefresh          ClientMethod = "workspace/diagnostic/refresh"          // client request
 	MethodWorkspaceFoldingRangeRefresh        ClientMethod = "workspace/foldingRange/refresh"        // client request
 	MethodWorkspaceInlayHintRefresh           ClientMethod = "workspace/inlayHint/refresh"           // client request
 	MethodWorkspaceInlineValueRefresh         ClientMethod = "workspace/inlineValue/refresh"         // client request
-	MethodClientRegisterCapability            ClientMethod = "client/registerCapability"             // client request
 	MethodWorkspaceSemanticTokensRefresh      ClientMethod = "workspace/semanticTokens/refresh"      // client request
-	MethodWindowShowDocument                  ClientMethod = "window/showDocument"                   // client request
-	MethodWindowShowMessageRequest            ClientMethod = "window/showMessageRequest"             // client request
 	MethodWorkspaceTextDocumentContentRefresh ClientMethod = "workspace/textDocumentContent/refresh" // client request
-	MethodClientUnregisterCapability          ClientMethod = "client/unregisterCapability"           // client request
-	MethodWindowWorkDoneProgressCreate        ClientMethod = "window/workDoneProgress/create"        // client request
 	MethodWorkspaceWorkspaceFolders           ClientMethod = "workspace/workspaceFolders"            // client request
 )
 
@@ -39,19 +39,36 @@ type Client interface {
 
 	Progress(ctx context.Context, params *ProgressParams) error
 
-	// LogMessage the log message notification is sent from the server to the client to ask the client to log a particular message.
-	LogMessage(ctx context.Context, params *LogMessageParams) error
-
 	LogTrace(ctx context.Context, params *LogTraceParams) error
 
+	// TelemetryEvent the telemetry event notification is sent from the server to the client to ask the client to log telemetry data.
+	TelemetryEvent(ctx context.Context, params any) error
+
 	// PublishDiagnostics diagnostics notification are sent from the server to the client to signal results of validation runs.
 	PublishDiagnostics(ctx context.Context, params *PublishDiagnosticsParams) error
 
+	// LogMessage the log message notification is sent from the server to the client to ask the client to log a particular message.
+	LogMessage(ctx context.Context, params *LogMessageParams) error
+
 	// ShowMessage the show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.
 	ShowMessage(ctx context.Context, params *ShowMessageParams) error
+	// Registration the `client/registerCapability` request is sent from the server to the client to register a new capability handler on the client side.
+	Registration(ctx context.Context, params *RegistrationParams) error
+
+	// Unregistration the `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability handler on the client side.
+	Unregistration(ctx context.Context, params *UnregistrationParams) error
+
+	// ShowDocument a request to show a document. This request might open an external program depending on the value of the URI to open. For example a request to open `https://code.visualstudio.com/` will very likely open the URI in a WEB browser.
+	//
+	// @since 3.16.0
+	ShowDocument(ctx context.Context, params *ShowDocumentParams) (*ShowDocumentResult, error)
+
+	// ShowMessageRequest the show message request is sent from the server to the client to show a message and a set of options actions to the user.
+	ShowMessageRequest(ctx context.Context, params *ShowMessageRequestParams) (*MessageActionItem, error)
+
+	// WorkDoneProgressCreate the `window/workDoneProgress/create` request is sent from the server to the client to initiate progress reporting from the server.
+	WorkDoneProgressCreate(ctx context.Context, params *WorkDoneProgressCreateParams) error
 
-	// TelemetryEvent the telemetry event notification is sent from the server to the client to ask the client to log telemetry data.
-	TelemetryEvent(ctx context.Context, params any) error
 	// ApplyWorkspaceEdit a request sent from the server to the client to modified certain resources.
 	ApplyWorkspaceEdit(ctx context.Context, params *ApplyWorkspaceEditParams) (*ApplyWorkspaceEditResult, error)
 
@@ -84,40 +101,25 @@ type Client interface {
 	// @since 3.17.0
 	InlineValueRefresh(ctx context.Context) error
 
-	// Registration the `client/registerCapability` request is sent from the server to the client to register a new capability handler on the client side.
-	Registration(ctx context.Context, params *RegistrationParams) error
-
 	// SemanticTokensRefresh.
 	//
 	// @since 3.16.0
 	SemanticTokensRefresh(ctx context.Context) error
 
-	// ShowDocument a request to show a document. This request might open an external program depending on the value of the URI to open. For example a request to open `https://code.visualstudio.com/` will very likely open the URI in a WEB browser.
-	//
-	// @since 3.16.0
-	ShowDocument(ctx context.Context, params *ShowDocumentParams) (*ShowDocumentResult, error)
-
-	// ShowMessageRequest the show message request is sent from the server to the client to show a message and a set of options actions to the user.
-	ShowMessageRequest(ctx context.Context, params *ShowMessageRequestParams) (*MessageActionItem, error)
-
 	// TextDocumentContentRefresh the `workspace/textDocumentContent` request is sent from the server to the client to refresh the content of a specific text document. 3.18.0 @proposed.
 	//
 	// @since 3.18.0 proposed
 	TextDocumentContentRefresh(ctx context.Context, params *TextDocumentContentRefreshParams) error
 
-	// Unregistration the `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability handler on the client side.
-	Unregistration(ctx context.Context, params *UnregistrationParams) error
-
-	// WorkDoneProgressCreate the `window/workDoneProgress/create` request is sent from the server to the client to initiate progress reporting from the server.
-	WorkDoneProgressCreate(ctx context.Context, params *WorkDoneProgressCreateParams) error
-
 	// WorkspaceFolders the `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
 	WorkspaceFolders(ctx context.Context) ([]*WorkspaceFolder, error)
 }
 
 // UnimplementedClient should be embedded to have forward compatible implementations.
 type UnimplementedClient struct{}
 
+var _ Client = UnimplementedClient{}
+
 func (UnimplementedClient) Cancel(ctx context.Context, params *CancelParams) error {
 	return jsonrpc2.ErrInternal
 }
@@ -126,23 +128,43 @@ func (UnimplementedClient) Progress(ctx context.Context, params *ProgressParams)
 	return jsonrpc2.ErrInternal
 }
 
-func (UnimplementedClient) LogMessage(ctx context.Context, params *LogMessageParams) error {
+func (UnimplementedClient) LogTrace(ctx context.Context, params *LogTraceParams) error {
 	return jsonrpc2.ErrInternal
 }
 
-func (UnimplementedClient) LogTrace(ctx context.Context, params *LogTraceParams) error {
+func (UnimplementedClient) TelemetryEvent(ctx context.Context, params any) error {
 	return jsonrpc2.ErrInternal
 }
 
 func (UnimplementedClient) PublishDiagnostics(ctx context.Context, params *PublishDiagnosticsParams) error {
 	return jsonrpc2.ErrInternal
 }
 
+func (UnimplementedClient) LogMessage(ctx context.Context, params *LogMessageParams) error {
+	return jsonrpc2.ErrInternal
+}
+
 func (UnimplementedClient) ShowMessage(ctx context.Context, params *ShowMessageParams) error {
 	return jsonrpc2.ErrInternal
 }
 
-func (UnimplementedClient) TelemetryEvent(ctx context.Context, params any) error {
+func (UnimplementedClient) Registration(ctx context.Context, params *RegistrationParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) Unregistration(ctx context.Context, params *UnregistrationParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) ShowDocument(ctx context.Context, params *ShowDocumentParams) (*ShowDocumentResult, error) {
+	return nil, jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) ShowMessageRequest(ctx context.Context, params *ShowMessageRequestParams) (*MessageActionItem, error) {
+	return nil, jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkDoneProgressCreate(ctx context.Context, params *WorkDoneProgressCreateParams) error {
 	return jsonrpc2.ErrInternal
 }
 
@@ -174,34 +196,14 @@ func (UnimplementedClient) InlineValueRefresh(ctx context.Context) error {
 	return jsonrpc2.ErrInternal
 }
 
-func (UnimplementedClient) Registration(ctx context.Context, params *RegistrationParams) error {
-	return jsonrpc2.ErrInternal
-}
-
 func (UnimplementedClient) SemanticTokensRefresh(ctx context.Context) error {
 	return jsonrpc2.ErrInternal
 }
 
-func (UnimplementedClient) ShowDocument(ctx context.Context, params *ShowDocumentParams) (*ShowDocumentResult, error) {
-	return nil, jsonrpc2.ErrInternal
-}
-
-func (UnimplementedClient) ShowMessageRequest(ctx context.Context, params *ShowMessageRequestParams) (*MessageActionItem, error) {
-	return nil, jsonrpc2.ErrInternal
-}
-
 func (UnimplementedClient) TextDocumentContentRefresh(ctx context.Context, params *TextDocumentContentRefreshParams) error {
 	return jsonrpc2.ErrInternal
 }
 
-func (UnimplementedClient) Unregistration(ctx context.Context, params *UnregistrationParams) error {
-	return jsonrpc2.ErrInternal
-}
-
-func (UnimplementedClient) WorkDoneProgressCreate(ctx context.Context, params *WorkDoneProgressCreateParams) error {
-	return jsonrpc2.ErrInternal
-}
-
 func (UnimplementedClient) WorkspaceFolders(ctx context.Context) ([]*WorkspaceFolder, error) {
 	return nil, jsonrpc2.ErrInternal
 }

protocol/document.go

@@ -128,7 +128,7 @@ type NotebookDocumentFilterWithCells struct {
 	// Notebook the notebook to be synced If a string value is provided it matches against the notebook type. '*' matches every notebook.
 	//
 	// @since 3.18.0
-	Notebook NotebookDocumentFilterWithCellsNotebook `json:"notebook,omitempty"`
+	Notebook *NotebookDocumentFilterWithCellsNotebook `json:"notebook,omitempty"`
 
 	// Cells the cells of the matching notebook to be synced.
 	//
@@ -349,7 +349,7 @@ type TextDocumentSyncOptions struct {
 	WillSaveWaitUntil bool `json:"willSaveWaitUntil,omitempty"`
 
 	// Save if present save notifications are sent to the server. If omitted the notification should not be sent.
-	Save TextDocumentSyncOptionsSave `json:"save,omitempty"`
+	Save *TextDocumentSyncOptionsSave `json:"save,omitempty"`
 }
 
 // DidOpenTextDocumentParams the parameters sent in an open text document notification.