commit | a6594121c294b66bccc12ed8298411891f03fd36 | [log] [tgz] |
---|---|---|
author | Dmitri Shuralyov <dmitshur@golang.org> | Sun Jan 27 13:55:40 2019 -0500 |
committer | Gopher Robot <gobot@golang.org> | Mon Jun 26 18:03:55 2023 +0000 |
tree | 16137696208383977c6a9b3d5a5ca7ca39ab0e10 | |
parent | 9d8d4089ca1bf8aa2bf11dbffa5803f76cf0968d [diff] |
go/vcs: deprecate package in favor of go list -json This package has diverged significantly from actual cmd/go import path resolution behavior. The recommended course of action is for people to start using the go command itself, where this logic is guaranteed to be up to date. cmd/go also has support for modules, while this package does not. I've considered two alternatives to deprecating this package: 1. Not deprecate it, keep it as is. This is not a good option because the package deviates from cmd/go import path resolution behavior and doesn't have all security fixes backported to it. Keeping it in this state without deprecating it can be misleading, since people may think this package implements the stated goal of matching cmd/go behavior and is well supported, which is not the current reality. 2. Not deprecate it, try to make it up to date with cmd/go import path resolution logic. This is not a good option because VCSs are no longer guaranteed to exist for packages located inside modules. To expose the import path to module resolution logic, the API of this package would need to be significantly modified. At this time, my understanding is such work is not in scope and people are encouraged to use the existing go command instead. In 2019, when this CL was mailed, deprecating seemed as the best option. In 2023, when this CL was merged, deprecating seemed as the best option. Fixes golang/go#11490. For golang/go#57051. Change-Id: Id32d2bec5706c4e87126b825de5215fa5d1ba8ac Reviewed-on: https://go-review.googlesource.com/c/tools/+/159818 gopls-CI: kokoro <noreply+kokoro@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Reviewed-by: Bryan Mills <bcmills@google.com> Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
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.