| commit | fbb25cbbd5ff5845639a3035f1fb7ddfd0ac0624 | [log] [tgz] |
|---|---|---|
| author | Alan Donovan <adonovan@google.com> | Fri Feb 24 11:10:09 2023 -0500 |
| committer | Alan Donovan <adonovan@google.com> | Wed Mar 01 21:29:20 2023 +0000 |
| tree | a38ab8d479619d6efa0c674d4a5cfc63bcb05bf2 | |
| parent | 096bae8f4da4d190e49e9d68216d21ed52aed0d3 [diff] |
gopls: use go generate consistently
This change establishes that "go generate ./..." from within the gopls
directory will update all generated code in the module to its
canonical version. (Beware that this command doesn't work in the
parent directory due to golang/go#58723.)
Details:
- The main 'generate' command now includes the canonical git ref
name of the LSP protocol used by gopls, and by default it
clones the repo at this version instead of using the version in
pjw's home directory. ;-)
It should deliver identical results for all users without setup.
The "generated" comment includes an accurate URL.
The timestamp is removed since it is nondeterministic.
- In addition to the commit hash, the output now reports the git
ref (branch/tag) name, which is not the same as the
metadata.version (LSP protocol version) string.
- The go:generate comments are now more prominent in their
respective files. We hide several that appear in testdata from
the go command by splitting string literals.
- Improved command documentation for generators.
- Use a slice not map for genTypes so that protocol generation
is deterministic. (Previously the "created for" comments
would alternate between TextDocumentFilter_Item{0,1}.)
The generated output has changed trivially ("//x" -> "// x")
because the most recent committed generated files was stale
wrt recent generator changes. Also, line number comments now
start at 1, not zero (eliminating a TODO).
Change-Id: I40e9454d0042507bd64e0d8fab3ce6b1fbe87ddc
Reviewed-on: https://go-review.googlesource.com/c/tools/+/471115
Run-TryBot: Alan Donovan <adonovan@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
Reviewed-by: Peter Weinberger <pjw@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.