| commit | 7e1bfe8bc98ca8e94b7853eca0993bc9ee369101 | [log] [tgz] |
|---|---|---|
| author | Alan Donovan <adonovan@google.com> | Sun Jul 16 13:14:42 2023 -0400 |
| committer | Gopher Robot <gobot@golang.org> | Fri Aug 25 16:25:05 2023 +0000 |
| tree | 2a8ca5df611e6ef665bf63a07a8c0dc2d177de7d | |
| parent | 39bfef48d3b68fca9707aae7b9961202bc76ad55 [diff] |
go/analysis/unitchecker: Example of separate analysis This change adds an Example that demonstrates the principle of separate analysis by having one program (the manager) visit the import graph in postorder, invoking a second program (the worker) as a child process once per package. The manager is analogous to go vet, and the worker to the vettool. Because unitchecker is closely coupled to go vet, both in its config file, and in assumptions about where and how facts and types are produced, this change parameterizes unitchecker to illustrate that not just facts but types too may be produced by the worker, without the need for the compiler. This may be a simpler and more efficient design for (say) a distributed analysis system. There are no changes to the public API yet (a proposal will follow) so the example can't yet serve directly as the basis for a new implementation, but in the meantime it should at least illuminate what is involved and, perhaps, how unitchecker can be easily forked and adapted. The changes to unitchecker should not affect the behavior of existing programs. Change-Id: I4ae414ccde91853c77b8a45771dd6e5cfc015173 Reviewed-on: https://go-review.googlesource.com/c/tools/+/510215 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com> Auto-Submit: Alan Donovan <adonovan@google.com> Run-TryBot: 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.