github.com/powerman/golang-tools@v0.1.11-0.20220410185822-5ad214d8d803/internal/lsp/cmd/prepare_rename.go (about)

     1  // Copyright 2019 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package cmd
     6  
     7  import (
     8  	"context"
     9  	"flag"
    10  	"fmt"
    11  
    12  	"github.com/powerman/golang-tools/internal/lsp/protocol"
    13  	"github.com/powerman/golang-tools/internal/span"
    14  	"github.com/powerman/golang-tools/internal/tool"
    15  	errors "golang.org/x/xerrors"
    16  )
    17  
    18  // prepareRename implements the prepare_rename verb for gopls.
    19  type prepareRename struct {
    20  	app *Application
    21  }
    22  
    23  func (r *prepareRename) Name() string      { return "prepare_rename" }
    24  func (r *prepareRename) Parent() string    { return r.app.Name() }
    25  func (r *prepareRename) Usage() string     { return "<position>" }
    26  func (r *prepareRename) ShortHelp() string { return "test validity of a rename operation at location" }
    27  func (r *prepareRename) DetailedHelp(f *flag.FlagSet) {
    28  	fmt.Fprint(f.Output(), `
    29  Example:
    30  
    31  	$ # 1-indexed location (:line:column or :#offset) of the target identifier
    32  	$ gopls prepare_rename helper/helper.go:8:6
    33  	$ gopls prepare_rename helper/helper.go:#53
    34  `)
    35  	printFlagDefaults(f)
    36  }
    37  
    38  // ErrInvalidRenamePosition is returned when prepareRename is run at a position that
    39  // is not a candidate for renaming.
    40  var ErrInvalidRenamePosition = errors.New("request is not valid at the given position")
    41  
    42  func (r *prepareRename) Run(ctx context.Context, args ...string) error {
    43  	if len(args) != 1 {
    44  		return tool.CommandLineErrorf("prepare_rename expects 1 argument (file)")
    45  	}
    46  
    47  	conn, err := r.app.connect(ctx)
    48  	if err != nil {
    49  		return err
    50  	}
    51  	defer conn.terminate(ctx)
    52  
    53  	from := span.Parse(args[0])
    54  	file := conn.AddFile(ctx, from.URI())
    55  	if file.err != nil {
    56  		return file.err
    57  	}
    58  	loc, err := file.mapper.Location(from)
    59  	if err != nil {
    60  		return err
    61  	}
    62  	p := protocol.PrepareRenameParams{
    63  		TextDocumentPositionParams: protocol.TextDocumentPositionParams{
    64  			TextDocument: protocol.TextDocumentIdentifier{URI: loc.URI},
    65  			Position:     loc.Range.Start,
    66  		},
    67  	}
    68  	result, err := conn.PrepareRename(ctx, &p)
    69  	if err != nil {
    70  		return errors.Errorf("prepare_rename failed: %w", err)
    71  	}
    72  	if result == nil {
    73  		return ErrInvalidRenamePosition
    74  	}
    75  
    76  	l := protocol.Location{Range: result.Range}
    77  	s, err := file.mapper.Span(l)
    78  	if err != nil {
    79  		return err
    80  	}
    81  
    82  	fmt.Println(s)
    83  	return nil
    84  }