gopls/internal/golang: CodeAction: place gopls doc as the last action

This CL adjusts the position of 'gopls.doc.features' at the end of the code action producers to offer it as the last action. It also checks the order of each action in unit test rather than checking existence. Fixes golang/go#72742 Change-Id: I062792a5608fc3d0b4c04334389a4d7066873c62 Reviewed-on: https://go-review.googlesource.com/c/tools/+/662915 Auto-Submit: Alan Donovan <adonovan@google.com> Reviewed-by: Alan Donovan <adonovan@google.com> Reviewed-by: Carlos Amedee <carlos@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>

Author: xieyuschen

gopls/internal/cmd/integration_test.go

@@ -1010,9 +1010,9 @@ type C struct{}
 res := gopls(t, tree, "codeaction", "-title=Browse.*doc", "a/a.go")
 res.checkExit(true)
 got := res.stdout
-want := `command	"Browse gopls feature documentation" [gopls.doc.features]` +
+want := `command	"Browse documentation for package a" [source.doc]` +
 "\n" +
-`command	"Browse documentation for package a" [source.doc]` +
+`command	"Browse gopls feature documentation" [gopls.doc.features]` +
 "\n"
 if got != want {
 t.Errorf("codeaction: got <<%s>>, want <<%s>>\nstderr:\n%s", got, want, res.stderr)

gopls/internal/golang/codeaction.go

@@ -14,7 +14,6 @@ import (
 "path/filepath"
 "reflect"
 "slices"
-"sort"
 "strings"
 
 "golang.org/x/tools/go/ast/astutil"
@@ -112,10 +111,7 @@ func CodeActions(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle,
 }
 }
 
-sort.Slice(actions, func(i, j int) bool {
-return actions[i].Kind < actions[j].Kind
-})
-
+// Return code actions in the order their providers are listed.
 return actions, nil
 }
 
@@ -233,6 +229,8 @@ type codeActionProducer struct {
 needPkg bool // fn needs type information (req.pkg)
 }
 
+// Code Actions are returned in the order their producers are listed below.
+// Depending on the client, this may influence the order they appear in the UI.
 var codeActionProducers = [...]codeActionProducer{
 {kind: protocol.QuickFix, fn: quickFix, needPkg: true},
 {kind: protocol.SourceOrganizeImports, fn: sourceOrganizeImports},
@@ -242,7 +240,6 @@ var codeActionProducers = [...]codeActionProducer{
 {kind: settings.GoFreeSymbols, fn: goFreeSymbols},
 {kind: settings.GoTest, fn: goTest, needPkg: true},
 {kind: settings.GoToggleCompilerOptDetails, fn: toggleCompilerOptDetails},
-{kind: settings.GoplsDocFeatures, fn: goplsDocFeatures},
 {kind: settings.RefactorExtractFunction, fn: refactorExtractFunction},
 {kind: settings.RefactorExtractMethod, fn: refactorExtractMethod},
 {kind: settings.RefactorExtractToNewFile, fn: refactorExtractToNewFile},
@@ -261,6 +258,7 @@ var codeActionProducers = [...]codeActionProducer{
 {kind: settings.RefactorRewriteMoveParamRight, fn: refactorRewriteMoveParamRight, needPkg: true},
 {kind: settings.RefactorRewriteSplitLines, fn: refactorRewriteSplitLines, needPkg: true},
 {kind: settings.RefactorRewriteEliminateDotImport, fn: refactorRewriteEliminateDotImport, needPkg: true},
+{kind: settings.GoplsDocFeatures, fn: goplsDocFeatures}, // offer this one last (#72742)
 
 // Note: don't forget to update the allow-list in Server.CodeAction
 // when adding new query operations like GoTest and GoDoc that

gopls/internal/settings/codeactionkind.go

@@ -81,6 +81,7 @@ const (
 GoTest protocol.CodeActionKind = "source.test"
 GoToggleCompilerOptDetails protocol.CodeActionKind = "source.toggleCompilerOptDetails"
 AddTest protocol.CodeActionKind = "source.addTest"
+OrganizeImports protocol.CodeActionKind = "source.organizeImports"
 
 // gopls
 GoplsDocFeatures protocol.CodeActionKind = "gopls.doc.features"