Google Git
Sign in
go / tools / 255eeebbce77653b04b0d73a4d5f9436b38c8fdd
commit255eeebbce77653b04b0d73a4d5f9436b38c8fdd[log] [tgz]
authorAlan Donovan <adonovan@google.com>Thu Mar 09 10:17:50 2023 -0500
committerAlan Donovan <adonovan@google.com>Tue Mar 21 23:14:33 2023 +0000
treec8d528019d8ee843455cfd10d9ab828d0d7ccba3
parent1b71edab7d52e19b2335c97ee6e77658b6342d60 [diff]
go/.../analysisutil: ExtractDoc unifies Analyzer.Doc and package doc

This CL defines an internal function, ExtractDoc, which extracts
documentation from the analyzer's package doc. This allows a single
doc comment to serve as both the package doc comment (which is
served by sites such as pkg.go.dev) and the analyzer documentation
(which is accessible through the command-line tool), appropriately
formatted for both media.

Also, change all our analyzers with nontrivial documentation
to use it.

The chosen syntax permits a single doc comment to document multiple
analyzers and looks good in the pkgsite HTML rendering and the
go vet help output. The HTML heading anchors are predictable.

For now this is internal, but we might want to publish it.
(After a proposal.)

Updates golang/go#58950
See golang/go#57906

Change-Id: Ifc0f48e54c3e42bc598649a7139e178a1a653c13
Reviewed-on: https://go-review.googlesource.com/c/tools/+/474935
Run-TryBot: Alan Donovan <adonovan@google.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
48 files changed
tree: c8d528019d8ee843455cfd10d9ab828d0d7ccba3
  1. benchmark/
  2. blog/
  3. cmd/
  4. container/
  5. copyright/
  6. cover/
  7. go/
  8. godoc/
  9. gopls/
  10. imports/
  11. internal/
  12. playground/
  13. present/
  14. refactor/
  15. txtar/
  16. .gitattributes
  17. .gitignore
  18. .prettierrc
  19. codereview.cfg
  20. CONTRIBUTING.md
  21. go.mod
  22. go.sum
  23. LICENSE
  24. PATENTS
  25. README.md
README.md

Go Tools

PkgGoDev

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.

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.