gopls/internal/protocol: replace lsp link with experimental comment

Change-Id: Id3faa0b61cd3218f32f43be798f4490e0f82b6e3
Reviewed-on: https://go-review.googlesource.com/c/tools/+/736280
Auto-Submit: Alan Donovan <adonovan@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Madeline Kalil <mkalil@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
Commit-Queue: Alan Donovan <adonovan@google.com>

Author: h9jiang

gopls/internal/protocol/generate/output.go

@@ -31,15 +31,15 @@ var (
 
 func generateOutput(model *Model) {
 	for _, r := range model.Requests {
-		genDecl(model, r.Method, r.Params, r.Result, r.Direction)
+		genDecl(model, r.Method, r.Params, r.Result, r.Direction, r.Line == 0)
 		genCase(model, r.Method, r.Params, r.Result, r.Direction)
 		genFunc(model, r.Method, r.Params, r.Result, r.Direction, false)
 	}
 	for _, n := range model.Notifications {
 		if n.Method == "$/cancelRequest" {
 			continue // handled internally by jsonrpc2
 		}
-		genDecl(model, n.Method, n.Params, nil, n.Direction)
+		genDecl(model, n.Method, n.Params, nil, n.Direction, n.Line == 0)
 		genCase(model, n.Method, n.Params, nil, n.Direction)
 		genFunc(model, n.Method, n.Params, nil, n.Direction, true)
 	}
@@ -50,7 +50,7 @@ func generateOutput(model *Model) {
 	genMarshal()
 }
 
-func genDecl(model *Model, method string, param, result *Type, dir string) {
+func genDecl(model *Model, method string, param, result *Type, dir string, experiment bool) {
 	fname := methodName(method)
 	p := ""
 	if notNil(param) {
@@ -72,11 +72,28 @@ func genDecl(model *Model, method string, param, result *Type, dir string) {
 		p = ", *ParamConfiguration"
 		ret = "([]LSPAny, error)"
 	}
-	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
+
+	var msg string
+	{
+		var sb strings.Builder
+
+		if doc, ok := prependMethodDocComments[fname]; ok {
+			sb.WriteString(doc)
+			sb.WriteString("\n\t//\n")
+		}
+
+		if experiment {
+			sb.WriteString("\t// Note: This is a non-standard protocol extension.\n")
+		} else {
+			fragment := strings.ReplaceAll(strings.TrimPrefix(method, "$/"), "/", "_")
+			fmt.Fprintf(&sb, "\t%s", lspLink(model, fragment))
+		}
+
+		fmt.Fprintf(&sb, "\t%s(context.Context%s) %s\n", fname, p, ret)
+
+		msg = sb.String()
 	}
+
 	switch dir {
 	case "clientToServer":
 		sdecls[method] = msg

gopls/internal/protocol/generate/tables.go

@@ -303,7 +303,13 @@ var prependMethodDocComments = map[string]string{
 	// filled (re-filled) answers in the form until it obtains an
 	// ExecuteCommandParams with interactive properties empty (e.g. formFields,
 	// formAnswers). by then the original properties contains all information,
-	// the client can call "workspace/executeCommand" with the same param.`,
+	// the client can call "workspace/executeCommand" with the same param.
+	//
+	// Standard resolution (e.g., "codeAction/resolve") cannot be used here because
+	// it is often triggered eagerly (e.g., for previews), prohibiting interactive
+	// forms. "command/resolve" is introduced to handle the interactive flow
+	// strictly *after* the user has explicitly indicated intention (e.g., by
+	// clicking), making it safe for Code Actions and other refactorings.`,
 }
 
 // appendTypeProp specifies block of code (typically properties with doc comment)