7398f36f57
Change-Id: If4bd2e8cd8dded33d434f4b60217fa46fcf5e934 Reviewed-on: https://go-review.googlesource.com/c/tools/+/611796 Reviewed-by: Michael Matloob <matloob@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Run-TryBot: shuang cui <imcusg@gmail.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Zvonimir Pavlinovic <zpavlinovic@google.com> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> |
||
|---|---|---|
| benchmark/parse | ||
| blog | ||
| cmd | ||
| container/intsets | ||
| copyright | ||
| cover | ||
| go | ||
| godoc | ||
| gopls | ||
| imports | ||
| internal | ||
| playground | ||
| present | ||
| refactor | ||
| txtar | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierrc | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| PATENTS | ||
| README.md | ||
| codereview.cfg | ||
| go.mod | ||
| go.sum | ||
README.md
Go Tools
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/goimportsformats a Go program likego fmtand additionally inserts import statements for any packages required by the file after it is edited.cmd/callgraphprints the call graph of a Go program.cmd/digraphis a utility for manipulating directed graphs in textual notation.cmd/stringergenerates declarations (including aStringmethod) for "enum" types.cmd/toolstashis 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/ssaprovides a static single-assignment form (SSA) intermediate representation (IR) for Go programs, similar to a typical compiler, for use by analysis tools. -
go/packagesprovides a simple interface for loading, parsing, and type checking a complete Go program from source code. -
go/analysisprovides a framework for modular static analysis of Go programs. -
go/callgraphprovides call graphs of Go programs using a variety of algorithms with different trade-offs. -
go/ast/inspectorprovides an optimized means of traversing a Go parse tree for use in analysis tools. -
go/cfgprovides a simple control-flow graph (CFG) for a Go function. -
go/expectreads Go source files used as test inputs and interprets special comments within them as queries or assertions for testing. -
go/gcexportdataandgo/gccgoexportdataread and write the binary files containing type information used by the standard andgccgocompilers. -
go/types/objectpathprovides a stable naming scheme for named entities ("objects") in thego/typesAPI.
Numerous other packages provide more esoteric functionality.
Contributing
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.
JavaScript and CSS Formatting
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.