Google Git
Sign in
go / tools / 6e5f4255c4dbfe627d9696cf1691f5fe60ceec7d
commit6e5f4255c4dbfe627d9696cf1691f5fe60ceec7d[log] [tgz]
authorPeter Weinberger <pjw@google.com>Thu Feb 09 14:03:47 2023 -0500
committerPeter Weinberger <pjw@google.com>Thu Mar 16 15:43:32 2023 +0000
treebd6b5b599edf7d14c55c2acf3a4ea978beb9301d
parente5f7ae13a79f624b7414958de3f8c64693adfe8c [diff]
gopls/mod: show hint for discordant module versions

Sometimes a go.mod file specifies a version of a module that
is different from what Go ends up using. This CL adds
inlay hints to the go.mod file when that happens.

It can happen in a require or replace directive, when some other
module needs a different version.

Accepting the inlay hint will change the specified version to
the one that is used.

There is a new test.

And here is a real-life example:
Create a directory and initialize a go.work file with
go work init ./delve ./tools
git clone https://github.com/go-delve/delve.git
(cd delve; git checkout 4303ae45a8e2996b30d2318f239677a771aef9c1)
git clone https://go.googlesource.com/tools
(cd tools; git checkout 8111118043894a9c0eab886fc370ca123dcf48f1)
Then the delve go.mod file has a hint in the 'require' section.

Fixes: golang/go#57026

Change-Id: Ifb131ed852efad3e2f29524a529f8b23db0d9ee9
Reviewed-on: https://go-review.googlesource.com/c/tools/+/466976
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Peter Weinberger <pjw@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
Reviewed-by: Robert Findley <rfindley@google.com>
4 files changed
tree: bd6b5b599edf7d14c55c2acf3a4ea978beb9301d
  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.