commit | 096bae8f4da4d190e49e9d68216d21ed52aed0d3 | [log] [tgz] |
---|---|---|
author | Alan Donovan <adonovan@google.com> | Tue Feb 28 09:40:32 2023 -0500 |
committer | Alan Donovan <adonovan@google.com> | Wed Mar 01 16:36:58 2023 +0000 |
tree | 4223e5f0ce9c3736648d6e9416a43eb5d9d053d1 | |
parent | 120642f1f67506a651c1cf61b4ac89829d3ada38 [diff] |
internal/gcimporter: document non-idempotence of export∘import In gopls we were recently surprised to discover that the the message obtained by exporting a types.Package, and the message obtained by importing and reexporting that message, differ. (Specifically because the importer calls NewInterfaceType, which has a shortcut for empty interfaces, and this shortcut is not used by go/types, so the importer produces a more compact data structure than go/types. There may be other examples.) This change documents the longstanding invariant that the encoding is deterministic for a given types.Package data structure, while also explicitly disclaiming that the composition of export∘import is idemptotent. Change-Id: Ie07efc1046315cd2104e78714d8312ecdf10e817 Reviewed-on: https://go-review.googlesource.com/c/tools/+/472075 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com> Run-TryBot: Alan Donovan <adonovan@google.com> Reviewed-by: Matthew Dempsky <mdempsky@google.com> gopls-CI: kokoro <noreply+kokoro@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.