gopls/internal/protocol/generate: move injections to tables.go

For golang/go#76331

Change-Id: Id14b41c56789ad0fefc6fbd43bca9065a9008b60
Reviewed-on: https://go-review.googlesource.com/c/tools/+/722740
Auto-Submit: Hongxiang Jiang <hxjiang@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Alan Donovan <adonovan@google.com>

Author: h9jiang

gopls/internal/protocol/generate/main.go

@@ -147,23 +147,6 @@ func writeserver() {
 `)
 	out.WriteString("type Server interface {\n")
 	for _, k := range sdecls.keys() {
-		if k == "codeAction/resolve" {
-			sdecls[k] = `// To support microsoft/language-server-protocol#1164, the language server
-// need to read the client-supplied form answers and either returns a
-// CodeAction with errors in the form fields surfacing the error to the
-// client, or a CodeAction with properties the language client is waiting
-// for (e.g. edits, commands).
-//
-// The language client may call "codeAction/resolve" if the language server
-// returns a CodeAction with errors or try asking the user for completing the
-// form again.
-//
-// The language client may call "codeAction/resolve" multiple times with user
-// filled (re-filled) answers in the form until it obtains a CodeAction with
-// properties (e.g. edits, commands) it's waiting for.
-//
-` + sdecls[k]
-		}
 		out.WriteString(sdecls[k])
 	}
 	out.WriteString(`
@@ -212,50 +195,6 @@ func writeprotocol() {
 	hack("WorkspaceFoldersServerCapabilities", "WorkspaceFolders5Gn")
 	hack("_InitializeParams", "XInitializeParams")
 
-	// Insert a block of content into a type.
-	insert := func(key, content string) {
-		if _, ok := types[key]; !ok {
-			log.Fatalf("types[%q] not found", key)
-		}
-		idx := strings.LastIndex(types[key], "}")
-		if idx == -1 {
-			log.Fatalf("could not find '}' in type %q", key)
-		}
-		types[key] = types[key][:idx] + content + types[key][idx:]
-	}
-
-	// TODO(hxjiang): extend form resolve to codelens resolve.
-	insert("CodeAction", `
-// FormFields and FormAnswers allow the server and client to exchange
-// interactive questions and answers during a resolveCodeAction request.
-//
-// The server populates FormFields to define the schema. The server may
-// optionally populate FormAnswers to preserve previous user input; if
-// provided, the client may present these as default values.
-//
-// When the client responds, it must provide FormAnswers. The client is not
-// required to send FormFields back to the server.
-
-// FormFields defines the questions and validation errors.
-//
-// This is a server-to-client field. The language server defines these, and
-// the client uses them to render the form.
-//
-// Note: This is a non-standard protocol extension. See microsoft/language-server-protocol#1164.
-FormFields []FormField `+"`json:\"formFields,omitempty\"`")
-	insert("CodeAction", `
-// FormAnswers contains the values for the form questions.
-//
-// When sent by the language server, this field is optional but recommended
-// to support editing previous values.
-//
-// When sent by the language client, this field is required. The slice must
-// have the same length as FormFields (one answer per question), where the
-// answer at index i corresponds to the field at index i.
-//
-// Note: This is a non-standard protocol extension. See microsoft/language-server-protocol#1164.
-FormAnswers []any `+"`json:\"formAnswers,omitempty\"`")
-
 	for _, k := range types.keys() {
 		if k == "WatchKind" {
 			types[k] = "type WatchKind = uint32" // strict gopls compatibility needs the '='

gopls/internal/protocol/generate/output.go

@@ -74,6 +74,9 @@ func genDecl(model *Model, method string, param, result *Type, dir string) {
 	}
 	fragment := strings.ReplaceAll(strings.TrimPrefix(method, "$/"), "/", "_")
 	msg := fmt.Sprintf("\t%s\t%s(context.Context%s) %s\n", lspLink(model, fragment), fname, p, ret)
+	if doc, ok := prependMethodDocComments[fname]; ok {
+		msg = doc + "\n\t//\n" + msg
+	}
 	switch dir {
 	case "clientToServer":
 		sdecls[method] = msg
@@ -294,6 +297,10 @@ func genProps(out *bytes.Buffer, props []NameType, name string) {
 			fmt.Fprintf(out, "\t%s %s %s\n", goName(p.Name), tp, json)
 		}
 	}
+
+	if block, ok := appendTypeProp[name]; ok {
+		out.WriteString(block)
+	}
 }
 
 func genAliases(model *Model) {

gopls/internal/protocol/generate/tables.go

@@ -284,3 +284,55 @@ func methodName(method string) string {
 	}
 	return ans
 }
+
+// prependMethodDocComments specifies doc comments that will be prepend to
+// an LSP method name defined in both Server and Client interface.
+var prependMethodDocComments = map[string]string{
+	"ResolveCodeAction": `// To support microsoft/language-server-protocol#1164, the language server
+	// need to read the form with client-supplied answers and either returns a
+	// CodeAction with errors in the form surfacing the error to the client, or a
+	// CodeAction with properties the language client is waiting for (e.g. edits,
+	// commands).
+	//
+	// The language client may call "codeAction/resolve" if the language server
+	// returns a CodeAction with errors or try asking the user for completing the
+	// form again.
+	// The language client may call "codeAction/resolve" multiple times with user
+	// filled (re-filled) answers in the form until it obtains a CodeAction with
+	// properties (e.g. edits, commands) it's waiting for.`,
+}
+
+// appendTypeProp specifies block of code (typically properties with doc comment)
+// that will be append to a struct.
+var appendTypeProp = map[string]string{
+	"CodeAction": `
+	// FormFields and FormAnswers allow the server and client to exchange
+	// interactive questions and answers during a resolveCodeAction request.
+	//
+	// The server populates FormFields to define the schema. The server may
+	// optionally populate FormAnswers to preserve previous user input; if
+	// provided, the client may present these as default values.
+	//
+	// When the client responds, it must provide FormAnswers. The client is not
+	// required to send FormFields back to the server.
+
+	// FormFields defines the questions and validation errors.
+	//
+	// This is a server-to-client field. The language server defines these, and
+	// the client uses them to render the form.
+	//
+	// Note: This is a non-standard protocol extension. See microsoft/language-server-protocol#1164.
+	FormFields []FormField ` + "`json:\"formFields,omitempty\"`" + `
+
+	// FormAnswers contains the values for the form questions.
+	//
+	// When sent by the language server, this field is optional but recommended
+	// to support editing previous values.
+	//
+	// When sent by the language client, this field is required. The slice must
+	// have the same length as FormFields (one answer per question), where the
+	// answer at index i corresponds to the field at index i.
+	//
+	// Note: This is a non-standard protocol extension. See microsoft/language-server-protocol#1164.
+	FormAnswers []any ` + "`json:\"formAnswers,omitempty\"`",
+}