WIP2

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

Author: zchee

.golangci.yml

@@ -85,7 +85,6 @@ linters:
     - staticcheck               # It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint.
     - stylecheck                # Stylecheck is a replacement for golint
     - tagalign                  # check that struct tags are well aligned
-    - tagliatelle               # Checks the struct tags.
     - tenv                      # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
     - testableexamples          # linter checks if examples are testable (have an expected output)
     - thelper                   # thelper detects Go test helpers without t.Helper() call and checks the consistency of test helpers

client.go

@@ -0,0 +1,197 @@
+// Copyright 2024 The Go Language Server Authors
+// SPDX-License-Identifier: BSD-3-Clause
+
+package protocol
+
+import (
+	"context"
+
+	"go.lsp.dev/jsonrpc2"
+)
+
+const (
+	MethodClientCancelRequest            ClientMethod = "$/cancelRequest"                  // bidirect client notification
+	MethodClientProgress                 ClientMethod = "$/progress"                       // bidirect 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
+	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
+	MethodWorkspaceSemanticTokensRefresh ClientMethod = "workspace/semanticTokens/refresh" // client request
+	MethodWorkspaceWorkspaceFolders      ClientMethod = "workspace/workspaceFolders"       // client request
+)
+
+type Client interface {
+	CancelRequest(ctx context.Context, params *CancelParams) error
+
+	Progress(ctx context.Context, params *ProgressParams) 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
+
+	// TextDocumentPublishDiagnostics diagnostics notification are sent from the server to the client to signal results of validation runs.
+	TextDocumentPublishDiagnostics(ctx context.Context, params *PublishDiagnosticsParams) error
+
+	// WindowLogMessage the log message notification is sent from the server to the client to ask the client to log a particular message.
+	WindowLogMessage(ctx context.Context, params *LogMessageParams) error
+
+	// WindowShowMessage 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.
+	WindowShowMessage(ctx context.Context, params *ShowMessageParams) error
+	// ClientRegisterCapability the `client/registerCapability` request is sent from the server to the client to register a new capability handler on the client side.
+	ClientRegisterCapability(ctx context.Context, params *RegistrationParams) error
+
+	// ClientUnregisterCapability the `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability handler on the client side.
+	ClientUnregisterCapability(ctx context.Context, params *UnregistrationParams) error
+
+	// WindowShowDocument 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
+	WindowShowDocument(ctx context.Context, params *ShowDocumentParams) (*ShowDocumentResult, error)
+
+	// WindowShowMessageRequest 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.
+	WindowShowMessageRequest(ctx context.Context, params *ShowMessageRequestParams) (*MessageActionItem, error)
+
+	// WindowWorkDoneProgressCreate the `window/workDoneProgress/create` request is sent from the server to the client to initiate progress reporting from the server.
+	WindowWorkDoneProgressCreate(ctx context.Context, params *WorkDoneProgressCreateParams) error
+
+	// WorkspaceApplyEdit a request sent from the server to the client to modified certain resources.
+	WorkspaceApplyEdit(ctx context.Context, params *ApplyWorkspaceEditParams) (*ApplyWorkspaceEditResult, error)
+
+	// WorkspaceCodeLensRefresh a request to refresh all code actions
+	//
+	// @since 3.16.0
+	WorkspaceCodeLensRefresh(ctx context.Context) error
+
+	// WorkspaceConfiguration the 'workspace/configuration' request is sent from the server to the client to fetch a certain configuration setting. This pull model replaces the old push model were the client signaled configuration
+	// change via an event. If the server still needs to react to configuration changes (since the server caches the result of `workspace/configuration` requests) the server should register for an empty configuration change event and empty the cache if such an event is received.
+	WorkspaceConfiguration(ctx context.Context, params *ConfigurationParams) ([]any, error)
+
+	// WorkspaceDiagnosticRefresh the diagnostic refresh request definition.
+	//
+	// @since 3.17.0
+	WorkspaceDiagnosticRefresh(ctx context.Context) error
+
+	// WorkspaceFoldingRangeRefresh.
+	//
+	// @since 3.18.0 proposed
+	WorkspaceFoldingRangeRefresh(ctx context.Context) error
+
+	// WorkspaceInlayHintRefresh.
+	//
+	// @since 3.17.0
+	WorkspaceInlayHintRefresh(ctx context.Context) error
+
+	// WorkspaceInlineValueRefresh.
+	//
+	// @since 3.17.0
+	WorkspaceInlineValueRefresh(ctx context.Context) error
+
+	// WorkspaceSemanticTokensRefresh.
+	//
+	// @since 3.16.0
+	WorkspaceSemanticTokensRefresh(ctx context.Context) error
+
+	// WorkspaceWorkspaceFolders the `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
+	WorkspaceWorkspaceFolders(ctx context.Context) ([]*WorkspaceFolder, error)
+}
+
+// UnimplementedClient should be embedded to have forward compatible implementations.
+type UnimplementedClient struct{}
+
+func (UnimplementedClient) CancelRequest(ctx context.Context, params *CancelParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) Progress(ctx context.Context, params *ProgressParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) LogTrace(ctx context.Context, params *LogTraceParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) TelemetryEvent(ctx context.Context, params any) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) TextDocumentPublishDiagnostics(ctx context.Context, params *PublishDiagnosticsParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WindowLogMessage(ctx context.Context, params *LogMessageParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WindowShowMessage(ctx context.Context, params *ShowMessageParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) ClientRegisterCapability(ctx context.Context, params *RegistrationParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) ClientUnregisterCapability(ctx context.Context, params *UnregistrationParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WindowShowDocument(ctx context.Context, params *ShowDocumentParams) (*ShowDocumentResult, error) {
+	return nil, jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WindowShowMessageRequest(ctx context.Context, params *ShowMessageRequestParams) (*MessageActionItem, error) {
+	return nil, jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WindowWorkDoneProgressCreate(ctx context.Context, params *WorkDoneProgressCreateParams) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceApplyEdit(ctx context.Context, params *ApplyWorkspaceEditParams) (*ApplyWorkspaceEditResult, error) {
+	return nil, jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceCodeLensRefresh(ctx context.Context) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceConfiguration(ctx context.Context, params *ConfigurationParams) ([]any, error) {
+	return nil, jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceDiagnosticRefresh(ctx context.Context) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceFoldingRangeRefresh(ctx context.Context) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceInlayHintRefresh(ctx context.Context) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceInlineValueRefresh(ctx context.Context) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceSemanticTokensRefresh(ctx context.Context) error {
+	return jsonrpc2.ErrInternal
+}
+
+func (UnimplementedClient) WorkspaceWorkspaceFolders(ctx context.Context) ([]*WorkspaceFolder, error) {
+	return nil, jsonrpc2.ErrInternal
+}

client_interface.go

@@ -9,15 +9,15 @@
 // It is a literal transcription, with unmodified comments, and only the changes
 // required to make it Go code.
 //
-// - Names are uppercased to export them.
+// Names are uppercased to export them.
 //
-// - All fields have JSON tags added to correct the names.
+// All fields have JSON tags added to correct the names.
 //
-// - Fields marked with a ? are also marked as "omitempty".
+// Fields marked with a ? are also marked as "omitempty".
 //
-// - Fields that are "|| null" are made pointers.
+// Fields that are "|| null" are made pointers.
 //
-// - Fields that are string or number are left as string.
+// Fields that are string or number are left as string.
 //
-// - Fields that are type "number" are made float64.
+// Fields that are type "number" are made float64.
 package protocol // import "go.lsp.dev/protocol"

doc.go

@@ -1,9 +1,11 @@
-// SPDX-FileCopyrightText: 2021 The Go Language Server Authors
+// Copyright 2024 The Go Language Server Authors
 // SPDX-License-Identifier: BSD-3-Clause
 
 package protocol
 
-import "go.lsp.dev/jsonrpc2"
+import (
+	"go.lsp.dev/jsonrpc2"
+)
 
 const (
 	// LSPReservedErrorRangeStart is the start range of LSP reserved error codes.

errors.go

@@ -3,16 +3,15 @@ module go.lsp.dev/protocol
 go 1.22.2
 
 require (
-	github.com/google/go-cmp v0.6.0
-	github.com/segmentio/encoding v0.4.0
 	go.lsp.dev/jsonrpc2 v0.10.0
-	go.lsp.dev/pkg v0.0.0-20210717090340-384b27a52fb2
 	go.lsp.dev/uri v0.3.0
 	go.uber.org/zap v1.27.0
 )
 
 require (
+	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/segmentio/asm v1.1.3 // indirect
+	github.com/segmentio/encoding v0.4.0 // indirect
 	go.uber.org/multierr v1.10.0 // indirect
 	golang.org/x/sys v0.0.0-20220319134239-a9b59b0215f8 // indirect
 )

go.mod

@@ -13,8 +13,6 @@ github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKs
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 go.lsp.dev/jsonrpc2 v0.10.0 h1:Pr/YcXJoEOTMc/b6OTmcR1DPJ3mSWl/SWiU1Cct6VmI=
 go.lsp.dev/jsonrpc2 v0.10.0/go.mod h1:fmEzIdXPi/rf6d4uFcayi8HpFP1nBF99ERP1htC72Ac=
-go.lsp.dev/pkg v0.0.0-20210717090340-384b27a52fb2 h1:hCzQgh6UcwbKgNSRurYWSqh8MufqRRPODRBblutn4TE=
-go.lsp.dev/pkg v0.0.0-20210717090340-384b27a52fb2/go.mod h1:gtSHRuYfbCT0qnbLnovpie/WEmqyJ7T4n6VXiFMBtcw=
 go.lsp.dev/uri v0.3.0 h1:KcZJmh6nFIBeJzTugn5JTU6OOyG0lDOo3R9KwTxTYbo=
 go.lsp.dev/uri v0.3.0/go.mod h1:P5sbO1IQR+qySTWOCnhnK7phBx+W3zbLqSMDJNTw88I=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=

go.sum

@@ -5,12 +5,79 @@ package protocol
 
 import (
 	"context"
+	"encoding/json"
+	"io"
 
 	"go.uber.org/zap"
 
 	"go.lsp.dev/jsonrpc2"
 )
 
+// MarshalFunc function type of marshal JSON data.
+//
+// Default is used [json.Marshal].
+type MarshalFunc func(v any) ([]byte, error)
+
+var marshal MarshalFunc = json.Marshal
+
+func RegiserMarshaler(fn MarshalFunc) {
+	marshal = fn
+}
+
+// UnmarshalFunc function type of unmarshal JSON data.
+//
+// Default is used [json.Unmarshal].
+type UnmarshalFunc func(data []byte, v any) error
+
+var unmarshal UnmarshalFunc = json.Unmarshal
+
+func RegiserUnmarshaler(fn UnmarshalFunc) {
+	unmarshal = fn
+}
+
+// JSONEncoder encodes and writes to the underlying data stream.
+type JSONEncoder interface {
+	Encode(any) error
+}
+
+// EncoderFunc function type of JSONEncoder.
+//
+// Default is used [json.NewEncoder] with SetEscapeHTML to false.
+type EncoderFunc func(io.Writer) JSONEncoder
+
+var newEncoder EncoderFunc = defaultEncoder
+
+func defaultEncoder(w io.Writer) JSONEncoder {
+	enc := json.NewEncoder(w)
+	enc.SetEscapeHTML(false)
+	return enc
+}
+
+func RegiserEncoder(fn EncoderFunc) {
+	newEncoder = fn
+}
+
+// JSONDecoder decodes and reads to the underlying data stream.
+type JSONDecoder interface {
+	Decode(v any) error
+}
+
+// DecoderFunc function type of JSONDecoder.
+//
+// Default is used [json.NewDecoder].
+type DecoderFunc func(io.Reader) JSONDecoder
+
+var newDecoder DecoderFunc = defaultDecoder
+
+func defaultDecoder(r io.Reader) JSONDecoder {
+	dec := json.NewDecoder(r)
+	return dec
+}
+
+func RegiserDecoder(fn DecoderFunc) {
+	newDecoder = fn
+}
+
 // NewServer returns the context in which client is embedded, jsonrpc2.Conn, and the Client.
 func NewServer(ctx context.Context, server Server, stream jsonrpc2.Stream, logger *zap.Logger) (context.Context, jsonrpc2.Conn, Client) {
 	conn := jsonrpc2.NewConn(stream)