Google Git
Sign in
go / tools / a7f033afe52dbc28c02f411b8727c4c2e379b0e0
commita7f033afe52dbc28c02f411b8727c4c2e379b0e0[log] [tgz]
authorRobert Findley <rfindley@google.com>Thu Jan 19 18:12:18 2023 -0500
committerRobert Findley <rfindley@google.com>Fri Jan 20 02:42:44 2023 +0000
tree20e09b78006b7d959c0c93baf8a38785c1488826
parent271e621c9735573bbab95ad33f04333a75c97f95 [diff]
gopls/internal/lsp: consolidate the FileHandle API

Clean up several aspects of the FileHandle APIs.
- Eliminate the VersionedFileHandle. There is no need for this
  specialization, when we already had the closedFile wrapper to make an
  on-disk file satisfy the Versioning interface.
- Remove the VersionedFileIdentity concept. This was an artifact of an
  earlier time when we stored files across sessions, views, and
  snapshots. In all remaining uses, a snapshot is implied.
- Clean up now-unnecessary APIs accordingly.
- Rename cache.fileHandle and cache.overlay to cache.DiskFile and
  cache.Overlay. There was some convenience to exporting Overlay, and
  DiskFile was exported for symmetry.
- Remove a bunch of unnecessary test boilerplate.
- Remove the link from Overlay to Session, as it was only necessary for
  debug templates.

Change-Id: I3cbf599c260d8e53c8ace913bbf92b2c6f054d3a
Reviewed-on: https://go-review.googlesource.com/c/tools/+/462818
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
32 files changed
tree: 20e09b78006b7d959c0c93baf8a38785c1488826
  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.