gopls: implement code action to split/group lines

Implement a code action to easily refactor function arguments, return
values, and composite literal elements into separate lines or a single
line.

This feature would be particularly helpful when working on large
business-related features that often require long variable names.
The ability to quickly split or group lines would significantly
accelerate refactoring efforts to ensure code adheres to specified
character limits.

Fixes golang/go#65156

Change-Id: I00aaa1377735f14808424e8e99fa0b7eeab90a7a
GitHub-Last-Rev: d3c5b57
GitHub-Pull-Request: #470
Reviewed-on: https://go-review.googlesource.com/c/tools/+/558475
Reviewed-by: Alan Donovan <[email protected]>
Auto-Submit: Alan Donovan <[email protected]>
Reviewed-by: Robert Findley <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>

Author: fatanugraha

gopls/internal/golang/codeaction.go

@@ -304,6 +304,32 @@ func getRewriteCodeActions(pkg *cache.Package, pgf *parsego.File, fh file.Handle
 		commands = append(commands, cmd)
 	}
 
+	if msg, ok, _ := CanSplitLines(pgf.File, pkg.FileSet(), start, end); ok {
+		cmd, err := command.NewApplyFixCommand(msg, command.ApplyFixArgs{
+			Fix:          fixSplitLines,
+			URI:          pgf.URI,
+			Range:        rng,
+			ResolveEdits: supportsResolveEdits(options),
+		})
+		if err != nil {
+			return nil, err
+		}
+		commands = append(commands, cmd)
+	}
+
+	if msg, ok, _ := CanJoinLines(pgf.File, pkg.FileSet(), start, end); ok {
+		cmd, err := command.NewApplyFixCommand(msg, command.ApplyFixArgs{
+			Fix:          fixJoinLines,
+			URI:          pgf.URI,
+			Range:        rng,
+			ResolveEdits: supportsResolveEdits(options),
+		})
+		if err != nil {
+			return nil, err
+		}
+		commands = append(commands, cmd)
+	}
+
 	// N.B.: an inspector only pays for itself after ~5 passes, which means we're
 	// currently not getting a good deal on this inspection.
 	//

gopls/internal/golang/fix.go

@@ -64,6 +64,8 @@ const (
 	fixExtractMethod     = "extract_method"
 	fixInlineCall        = "inline_call"
 	fixInvertIfCondition = "invert_if_condition"
+	fixSplitLines        = "split_lines"
+	fixJoinLines         = "join_lines"
 )
 
 // ApplyFix applies the specified kind of suggested fix to the given
@@ -115,6 +117,8 @@ func ApplyFix(ctx context.Context, fix string, snapshot *cache.Snapshot, fh file
 		fixExtractVariable:   singleFile(extractVariable),
 		fixInlineCall:        inlineCall,
 		fixInvertIfCondition: singleFile(invertIfCondition),
+		fixSplitLines:        singleFile(splitLines),
+		fixJoinLines:         singleFile(joinLines),
 	}
 	fixer, ok := fixers[fix]
 	if !ok {

gopls/internal/golang/lines.go

@@ -0,0 +1,261 @@
+// Copyright 2024 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package golang
+
+// This file defines refactorings for splitting lists of elements
+// (arguments, literals, etc) across multiple lines, and joining
+// them into a single line.
+
+import (
+	"bytes"
+	"go/ast"
+	"go/token"
+	"go/types"
+	"sort"
+	"strings"
+
+	"golang.org/x/tools/go/analysis"
+	"golang.org/x/tools/go/ast/astutil"
+	"golang.org/x/tools/gopls/internal/util/safetoken"
+	"golang.org/x/tools/gopls/internal/util/slices"
+)
+
+// CanSplitLines checks whether we can split lists of elements inside an enclosing curly bracket/parens into separate
+// lines.
+func CanSplitLines(file *ast.File, fset *token.FileSet, start, end token.Pos) (string, bool, error) {
+	itemType, items, comments, _, _, _ := findSplitJoinTarget(fset, file, nil, start, end)
+	if itemType == "" {
+		return "", false, nil
+	}
+
+	if !canSplitJoinLines(items, comments) {
+		return "", false, nil
+	}
+
+	for i := 1; i < len(items); i++ {
+		prevLine := safetoken.EndPosition(fset, items[i-1].End()).Line
+		curLine := safetoken.StartPosition(fset, items[i].Pos()).Line
+		if prevLine == curLine {
+			return "Split " + itemType + " into separate lines", true, nil
+		}
+	}
+
+	return "", false, nil
+}
+
+// CanJoinLines checks whether we can join lists of elements inside an enclosing curly bracket/parens into a single line.
+func CanJoinLines(file *ast.File, fset *token.FileSet, start, end token.Pos) (string, bool, error) {
+	itemType, items, comments, _, _, _ := findSplitJoinTarget(fset, file, nil, start, end)
+	if itemType == "" {
+		return "", false, nil
+	}
+
+	if !canSplitJoinLines(items, comments) {
+		return "", false, nil
+	}
+
+	for i := 1; i < len(items); i++ {
+		prevLine := safetoken.EndPosition(fset, items[i-1].End()).Line
+		curLine := safetoken.StartPosition(fset, items[i].Pos()).Line
+		if prevLine != curLine {
+			return "Join " + itemType + " into one line", true, nil
+		}
+	}
+
+	return "", false, nil
+}
+
+// canSplitJoinLines determines whether we should split/join the lines or not.
+func canSplitJoinLines(items []ast.Node, comments []*ast.CommentGroup) bool {
+	if len(items) <= 1 {
+		return false
+	}
+
+	for _, cg := range comments {
+		if !strings.HasPrefix(cg.List[0].Text, "/*") {
+			return false // can't split/join lists containing "//" comments
+		}
+	}
+
+	return true
+}
+
+// splitLines is a singleFile fixer.
+func splitLines(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, _ *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
+	itemType, items, comments, indent, braceOpen, braceClose := findSplitJoinTarget(fset, file, src, start, end)
+	if itemType == "" {
+		return nil, nil, nil // no fix available
+	}
+
+	return fset, processLines(fset, items, comments, src, braceOpen, braceClose, ",\n", "\n", ",\n"+indent, indent+"\t"), nil
+}
+
+// joinLines is a singleFile fixer.
+func joinLines(fset *token.FileSet, start, end token.Pos, src []byte, file *ast.File, _ *types.Package, _ *types.Info) (*token.FileSet, *analysis.SuggestedFix, error) {
+	itemType, items, comments, _, braceOpen, braceClose := findSplitJoinTarget(fset, file, src, start, end)
+	if itemType == "" {
+		return nil, nil, nil // no fix available
+	}
+
+	return fset, processLines(fset, items, comments, src, braceOpen, braceClose, ", ", "", "", ""), nil
+}
+
+// processLines is the common operation for both split and join lines because this split/join operation is
+// essentially a transformation of the separating whitespace.
+func processLines(fset *token.FileSet, items []ast.Node, comments []*ast.CommentGroup, src []byte, braceOpen, braceClose token.Pos, sep, prefix, suffix, indent string) *analysis.SuggestedFix {
+	nodes := slices.Clone(items)
+
+	// box *ast.CommentGroup to ast.Node for easier processing later.
+	for _, cg := range comments {
+		nodes = append(nodes, cg)
+	}
+
+	// Sort to interleave comments and nodes.
+	sort.Slice(nodes, func(i, j int) bool {
+		return nodes[i].Pos() < nodes[j].Pos()
+	})
+
+	edits := []analysis.TextEdit{
+		{
+			Pos:     token.Pos(int(braceOpen) + len("{")),
+			End:     nodes[0].Pos(),
+			NewText: []byte(prefix + indent),
+		},
+		{
+			Pos:     nodes[len(nodes)-1].End(),
+			End:     braceClose,
+			NewText: []byte(suffix),
+		},
+	}
+
+	for i := 1; i < len(nodes); i++ {
+		pos, end := nodes[i-1].End(), nodes[i].Pos()
+		if pos > end {
+			// this will happen if we have a /*-style comment inside of a Field
+			// e.g. `a /*comment here */ int`
+			//
+			// we will ignore as we only care about finding the field delimiter.
+			continue
+		}
+
+		// at this point, the `,` token in between 2 nodes here must be the field delimiter.
+		posOffset := safetoken.EndPosition(fset, pos).Offset
+		endOffset := safetoken.StartPosition(fset, end).Offset
+		if bytes.IndexByte(src[posOffset:endOffset], ',') == -1 {
+			// nodes[i] or nodes[i-1] is a comment hence no delimiter in between
+			// in such case, do nothing.
+			continue
+		}
+
+		edits = append(edits, analysis.TextEdit{Pos: pos, End: end, NewText: []byte(sep + indent)})
+	}
+
+	return &analysis.SuggestedFix{TextEdits: edits}
+}
+
+// findSplitJoinTarget returns the first curly bracket/parens that encloses the current cursor.
+func findSplitJoinTarget(fset *token.FileSet, file *ast.File, src []byte, start, end token.Pos) (itemType string, items []ast.Node, comments []*ast.CommentGroup, indent string, open, close token.Pos) {
+	isCursorInside := func(nodePos, nodeEnd token.Pos) bool {
+		return nodePos < start && end < nodeEnd
+	}
+
+	findTarget := func() (targetType string, target ast.Node, open, close token.Pos) {
+		path, _ := astutil.PathEnclosingInterval(file, start, end)
+		for _, node := range path {
+			switch node := node.(type) {
+			case *ast.FuncDecl:
+				// target struct method declarations.
+				//   function (...) someMethod(a int, b int, c int) (d int, e, int) {}
+				params := node.Type.Params
+				if isCursorInside(params.Opening, params.Closing) {
+					return "parameters", params, params.Opening, params.Closing
+				}
+
+				results := node.Type.Results
+				if results != nil && isCursorInside(results.Opening, results.Closing) {
+					return "return values", results, results.Opening, results.Closing
+				}
+			case *ast.FuncType:
+				// target function signature args and result.
+				//   type someFunc func (a int, b int, c int) (d int, e int)
+				params := node.Params
+				if isCursorInside(params.Opening, params.Closing) {
+					return "parameters", params, params.Opening, params.Closing
+				}
+
+				results := node.Results
+				if results != nil && isCursorInside(results.Opening, results.Closing) {
+					return "return values", results, results.Opening, results.Closing
+				}
+			case *ast.CallExpr:
+				// target function calls.
+				//   someFunction(a, b, c)
+				if isCursorInside(node.Lparen, node.Rparen) {
+					return "parameters", node, node.Lparen, node.Rparen
+				}
+			case *ast.CompositeLit:
+				// target composite lit instantiation (structs, maps, arrays).
+				//   A{b: 1, c: 2, d: 3}
+				if isCursorInside(node.Lbrace, node.Rbrace) {
+					return "elements", node, node.Lbrace, node.Rbrace
+				}
+			}
+		}
+
+		return "", nil, 0, 0
+	}
+
+	targetType, targetNode, open, close := findTarget()
+	if targetType == "" {
+		return "", nil, nil, "", 0, 0
+	}
+
+	switch node := targetNode.(type) {
+	case *ast.FieldList:
+		for _, field := range node.List {
+			items = append(items, field)
+		}
+	case *ast.CallExpr:
+		for _, arg := range node.Args {
+			items = append(items, arg)
+		}
+	case *ast.CompositeLit:
+		for _, arg := range node.Elts {
+			items = append(items, arg)
+		}
+	}
+
+	// preserve comments separately as it's not part of the targetNode AST.
+	for _, cg := range file.Comments {
+		if open <= cg.Pos() && cg.Pos() < close {
+			comments = append(comments, cg)
+		}
+	}
+
+	// indent is the leading whitespace before the opening curly bracket/paren.
+	//
+	// in case where we don't have access to src yet i.e. src == nil
+	// it's fine to return incorrect indent because we don't need it yet.
+	indent = ""
+	if len(src) > 0 {
+		var pos token.Pos
+		switch node := targetNode.(type) {
+		case *ast.FieldList:
+			pos = node.Opening
+		case *ast.CallExpr:
+			pos = node.Lparen
+		case *ast.CompositeLit:
+			pos = node.Lbrace
+		}
+
+		split := bytes.Split(src, []byte("\n"))
+		targetLineNumber := safetoken.StartPosition(fset, pos).Line
+		firstLine := string(split[targetLineNumber-1])
+		trimmed := strings.TrimSpace(string(firstLine))
+		indent = firstLine[:strings.Index(firstLine, trimmed)]
+	}
+
+	return targetType, items, comments, indent, open, close
+}