Repository files navigation

This repository provides thegolang.org/x/tools module, comprisingvarious 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 thegolang.org/x/tools/goplsmodule, whose root package is a language-server protocol (LSP) server for Go.An LSP server analyses the source code of a project andresponds to requests from a wide range of editors such as VSCode andVim, allowing them to support IDE-like functionality.

Selected commands:

• cmd/goimports formats a Go program likego fmt and additionallyinserts import statements for any packages required by the fileafter 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 aString 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) intermediaterepresentation (IR) for Go programs, similar to a typical compiler,for use by analysis tools.

• go/packages provides a simple interface for loading, parsing, andtype checking a complete Go program from source code.

• go/analysis provides a framework for modular static analysis of Goprograms.

• go/callgraph provides call graphs of Go programs using a varietyof algorithms with different trade-offs.

• go/ast/inspector provides an optimized means of traversing a Goparse tree for use in analysis tools.

• go/cfg provides a simple control-flow graph (CFG) for a Go function.

• go/gcexportdata andgo/gccgoexportdata read and write the binaryfiles containing type information used by the standard andgccgo compilers.

• go/types/objectpath provides a stable naming scheme for namedentities ("objects") in thego/types API.

Numerous other packages provide more esoteric functionality.

This repository uses Gerrit for code changes.To learn how to submit changes, seehttps://go.dev/doc/contribute.

The git repository ishttps://go.googlesource.com/tools.

The main issue tracker for the tools repository is located athttps://go.dev/issues. Prefix your issue with "x/tools/(yoursubdir):" in the subject line, so it is easy to find.

This repository usesprettier to format JS and CSS files.

The version ofprettier used is 1.18.2.

It is encouraged that all JS and CSS code be run through this before submittinga change. However, it is not a strict requirement enforced by CI.