| commit | d96b2388c6140f7db7021cead0968958a343057a | [log] [tgz] |
|---|---|---|
| author | Alan Donovan <adonovan@google.com> | Fri Sep 30 21:58:21 2022 -0400 |
| committer | Gopher Robot <gobot@golang.org> | Wed Oct 05 20:32:15 2022 +0000 |
| tree | 4e095c381d9e84af31b4943ae50ac8f6dce21aa8 | |
| parent | 9856077059c266cee0293924a2e80e630973289d [diff] |
internal/diff: simplify API, break span dependency diff.TextEdit (now called simply Edit) no longer has a Span, and no longer depends on the span package, which is really part of gopls. Instead, it records only start/end byte offsets within an (implied) file. The diff algorithms have been simplified to avoid the need to map offsets to line/column numbers (e.g. using a token.File). All the conditions actually needed by the logic can be derived by local string operations on the source text. This change will allow us to move the span package into the gopls module. I was expecting that gopls would want to define its own Span-augmented TextEdit type but, surprisingly, diff.Edit is quite convenient to use throughout the entire repo: in all places in gopls that manipulate Edits, the implied file is obvious. In most cases, less conversion boilerplate is required than before. API Notes: - diff.TextEdit -> Edit (it needn't be text) - diff.ApplyEdits -> Apply - source.protocolEditsFromSource is now private Change-Id: I4d7cef078dfbd189b4aef477f845db320af6c5f6 Reviewed-on: https://go-review.googlesource.com/c/tools/+/436781 Run-TryBot: Alan Donovan <adonovan@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> gopls-CI: kokoro <noreply+kokoro@google.com> Reviewed-by: Robert Findley <rfindley@google.com> Auto-Submit: Alan Donovan <adonovan@google.com>
This repository provides the golang.org/x/tools module, comprising various tools and packages mostly for static analysis of Go programs, some of which are listed below. Use the “Go reference” link above for more information about any package.
It also contains the golang.org/x/tools/gopls module, whose root package is a language-server protocol (LSP) server for Go. An LSP server analyses the source code of a project and responds to requests from a wide range of editors such as VSCode and Vim, allowing them to support IDE-like functionality.
Selected commands:
cmd/goimports formats a Go program like go fmt and additionally inserts import statements for any packages required by the file after it is edited.cmd/callgraph prints the call graph of a Go program.cmd/digraph is a utility for manipulating directed graphs in textual notation.cmd/stringer generates declarations (including a String method) for “enum” types.cmd/toolstash is a utility to simplify working with multiple versions of the Go toolchain.These commands may be fetched with a command such as go install golang.org/x/tools/cmd/goimports@latest.
Selected packages:
go/ssa provides a static single-assignment form (SSA) intermediate representation (IR) for Go programs, similar to a typical compiler, for use by analysis tools.
go/packages provides a simple interface for loading, parsing, and type checking a complete Go program from source code.
go/analysis provides a framework for modular static analysis of Go programs.
go/callgraph provides call graphs of Go programs using a variety of algorithms with different trade-offs.
go/ast/inspector provides an optimized means of traversing a Go parse tree for use in analysis tools.
go/cfg provides a simple control-flow graph (CFG) for a Go function.
go/expect reads Go source files used as test inputs and interprets special comments within them as queries or assertions for testing.
go/gcexportdata and go/gccgoexportdata read and write the binary files containing type information used by the standard and gccgo compilers.
go/types/objectpath provides a stable naming scheme for named entities (“objects”) in the go/types API.
Numerous other packages provide more esoteric functionality.
This repository uses Gerrit for code changes. To learn how to submit changes, see https://golang.org/doc/contribute.html.
The main issue tracker for the tools repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/tools/(your subdir):” in the subject line, so it is easy to find.
This repository uses prettier to format JS and CSS files.
The version of prettier used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.