Mirrors
/
go-tools
mirror of https://github.com/golang/tools.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
8,546 Commits
38 Branches
231 Tags
49 MiB
Go 98.1%
JavaScript 1%
HTML 0.4%
CSS 0.4%
 
 
 
 
Go to file
Alan Donovan 0b4dca13e9 gopls/internal/protocol: separate CodeLens from Command; document 
Historically, CodeLenses were identified in the UI (LSP, CLI, docs)
by the command.Command that they return, but this is confusing
and potentially ambiguous as a single lens algorithm may offer
many commands, potentially overlapping.

This change establishes a separate CodeLensKind identifier for
them. The actual string values must remain unchanged to avoid
breaking users.

The documentation generator now uses the doc comments attached
to these CodeLensKind enum declarations. I have updated and
elaborated the documentation for each one.

Change-Id: I4a331930ca6a22b85150615e87ee79a66434ebe3
Reviewed-on: https://go-review.googlesource.com/c/tools/+/586175
Auto-Submit: Alan Donovan <adonovan@google.com>
Reviewed-by: Robert Findley <rfindley@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
 		2024-05-17 21:14:34 +00:00
benchmark/parse benchmark/parse: fix format 2024-02-27 16:40:19 +00:00
blog copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
cmd toolstash: errors output should match errors guarded 2024-04-25 20:20:40 +00:00
container/intsets all: remove redundant type conversion 2022-09-07 17:33:19 +00:00
copyright x/tools: drop go1.18 support 2024-02-29 16:54:26 +00:00
cover cover: eliminate an unnecessary fsync in TestParseProfiles 2023-05-17 15:38:17 +00:00
go all: fix function names in comment 2024-05-17 16:49:08 +00:00
godoc x/tools: drop go1.18 support 2024-02-29 16:54:26 +00:00
gopls gopls/internal/protocol: separate CodeLens from Command; document 2024-05-17 21:14:34 +00:00
imports tools: replace references to obsolete package ioutils 2023-09-12 20:13:37 +00:00
internal all: fix function names in comment 2024-05-17 16:49:08 +00:00
playground all: replace all usages of golang.org/x/sys/execabs with os/exec 2023-11-09 20:10:26 +00:00
present x/tools: address review of CL 564515 (CombinedOutput) 2024-02-16 17:20:36 +00:00
refactor internal/aliases: expose Enabled 2024-04-23 20:27:57 +00:00
txtar tools: replace references to obsolete package ioutils 2023-09-12 20:13:37 +00:00
.gitattributes tools: copying .gitattributes to all subrepositories (fixes windows build) 2014-12-23 06:32:51 +00:00
.gitignore .gitignore: roll back ".gitignore: ignore emacs backup files" 2018-02-13 00:43:28 +00:00
.prettierrc all: add a section on JS/CSS formatting to README 2020-05-28 15:31:34 +00:00
CONTRIBUTING.md CONTRIBUTING.md: remove note about not accepting Pull Requests 2018-03-14 18:02:17 +00:00
LICENSE LICENSE: add 2012-03-17 15:20:58 +11:00
PATENTS go.empty: add PATENTS file to the subrepo. 2012-04-16 11:24:04 +10:00
README.md go/vcs: delete 2023-06-26 18:28:02 +00:00
codereview.cfg tools: add codereview.cfg 2015-03-18 17:04:00 +00:00
go.mod x/tools: update to x/telemetry@9ff3ad9 2024-05-15 22:01:09 +00:00
go.sum x/tools: update to x/telemetry@9ff3ad9 2024-05-15 22:01:09 +00:00

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.