mirror of
https://github.com/golang/go
synced 2024-11-19 03:14:42 -07:00
744a51dd88
This allows us to use the diff.ApplyEdits in tests, saving us from a different implementation. It also prepares for command lines that need to use diff features based on the results of a protocol message. Splitting content into lines is too easy to get wrong, and needs to be done correctly or the diff results make no sense. This adds the SplitLines function to the diff pacakge to do it right and then uses it everwhere we we already doing it wrong. It also makes all the diff tests external black box tests. Change-Id: I698227d5769a2bfbfd22a64ea42906b1df9268d9 Reviewed-on: https://go-review.googlesource.com/c/tools/+/171027 Run-TryBot: Ian Cottrell <iancottrell@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
68 lines
2.1 KiB
Go
68 lines
2.1 KiB
Go
// Copyright 2018 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 source provides core features for use by Go editors and tools.
|
|
package source
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"go/format"
|
|
|
|
"golang.org/x/tools/go/ast/astutil"
|
|
"golang.org/x/tools/go/packages"
|
|
"golang.org/x/tools/imports"
|
|
"golang.org/x/tools/internal/lsp/diff"
|
|
"golang.org/x/tools/internal/span"
|
|
)
|
|
|
|
// Format formats a file with a given range.
|
|
func Format(ctx context.Context, f File, rng span.Range) ([]TextEdit, error) {
|
|
pkg := f.GetPackage(ctx)
|
|
if hasParseErrors(pkg.GetErrors()) {
|
|
return nil, fmt.Errorf("%s has parse errors, not formatting", f.URI())
|
|
}
|
|
fAST := f.GetAST(ctx)
|
|
path, exact := astutil.PathEnclosingInterval(fAST, rng.Start, rng.End)
|
|
if !exact || len(path) == 0 {
|
|
return nil, fmt.Errorf("no exact AST node matching the specified range")
|
|
}
|
|
node := path[0]
|
|
// format.Node changes slightly from one release to another, so the version
|
|
// of Go used to build the LSP server will determine how it formats code.
|
|
// This should be acceptable for all users, who likely be prompted to rebuild
|
|
// the LSP server on each Go release.
|
|
fset := f.GetFileSet(ctx)
|
|
buf := &bytes.Buffer{}
|
|
if err := format.Node(buf, fset, node); err != nil {
|
|
return nil, err
|
|
}
|
|
return computeTextEdits(ctx, f, buf.String()), nil
|
|
}
|
|
|
|
func hasParseErrors(errors []packages.Error) bool {
|
|
for _, err := range errors {
|
|
if err.Kind == packages.ParseError {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Imports formats a file using the goimports tool.
|
|
func Imports(ctx context.Context, f File, rng span.Range) ([]TextEdit, error) {
|
|
formatted, err := imports.Process(f.GetToken(ctx).Name(), f.GetContent(ctx), nil)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return computeTextEdits(ctx, f, string(formatted)), nil
|
|
}
|
|
|
|
func computeTextEdits(ctx context.Context, file File, formatted string) (edits []TextEdit) {
|
|
u := diff.SplitLines(string(file.GetContent(ctx)))
|
|
f := diff.SplitLines(formatted)
|
|
return DiffToEdits(file.URI(), diff.Operations(u, f))
|
|
}
|