The Go programming language
Go to file
Hana (Hyang-Ah) Kim 4ef38dc8f2 gopls/internal/vulncheck/vulntest: add test helpers
This package hosts helper utilities for vulncheck features. This package requires go1.18+.

Most of the code were adopted from golang.org/x/vulndb/internal.

The first batch is NewDatabase reads YAML-format vulnerability
information files
(https://github.com/golang/vulndb/blob/master/doc/format.md)
packaged in txtar, and creates a filesystem-based vuln database
that can be used as a data source of golang.org/x/vuln/client
APIs.

See db_test.go for example.

* Source of the code

db.go:
  golang.org/x/vulndb/internal/database#Generate
report.go:
  golang.org/x/vulndb/internal/report#Report
stdlib.go:
  golang.org/x/vulndb/internal/stdlib

This change adds a new dependency on "gopkg.in/yaml.v3"
for parsing YAMLs in testing

Change-Id: Ica5da4284c38a8a9531b1f943deb4288a2058c9b
Reviewed-on: https://go-review.googlesource.com/c/tools/+/435358
Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
Reviewed-by: Robert Findley <rfindley@google.com>
2022-10-05 23:17:31 +00:00
benchmark/parse benchmark/parse: add unit test for String function 2019-12-16 21:43:19 +00:00
blog copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
cmd all: replace deprecated egrep with grep -E 2022-09-23 13:31:09 +00:00
container/intsets all: remove redundant type conversion 2022-09-07 17:33:19 +00:00
copyright gopls: migrate internal/lsp to gopls/internal/lsp 2022-09-07 16:44:44 +00:00
cover cover: add function to parse profiles from an io.Reader 2021-10-05 03:23:35 +00:00
go internal/diff: simplify API, break span dependency 2022-10-05 20:32:15 +00:00
godoc godoc: fix some comments 2022-10-04 18:24:48 +00:00
gopls gopls/internal/vulncheck/vulntest: add test helpers 2022-10-05 23:17:31 +00:00
imports all: gofmt 2022-04-12 17:53:17 +00:00
internal internal/diff: simplify API, break span dependency 2022-10-05 20:32:15 +00:00
playground playground: remove /share registration, add Proxy 2021-02-25 15:03:53 +00:00
present all: gofmt 2022-04-12 17:53:17 +00:00
refactor all: gofmt some recent file changes 2022-06-27 19:42:14 +00:00
txtar all: gofmt 2022-04-12 17:53:17 +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 README: restructure and update 2022-05-04 14:51:12 +00:00
codereview.cfg tools: add codereview.cfg 2015-03-18 17:04:00 +00:00
go.mod x/tools: update go.mod following moving LSP code to x/tools/gopls 2022-09-07 22:05:45 +00:00
go.sum x/tools: update go.mod following moving LSP code to x/tools/gopls 2022-09-07 22:05:45 +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.