.config/coc/extensions/coc-go-data/tools/pkg/mod/honnef.co/go/tools@v0.0.1-2020.1.5/README.md

   1 # honnef.co/go/tools
   2
   3 `honnef.co/go/tools/...` is a collection of tools and libraries for
   4 working with Go code, including linters and static analysis, most
   5 prominently staticcheck.
   6
   7 **These tools are financially supported by [private and corporate sponsors](http://staticcheck.io/sponsors) to ensure its continued development.
   8 Please consider [becoming a sponsor](https://github.com/users/dominikh/sponsorship) if you or your company relies on the tools.**
   9
  10
  11 ## Documentation
  12
  13 You can find extensive documentation on these tools, in particular staticcheck, on [staticcheck.io](https://staticcheck.io/docs/).
  14
  15
  16 ## Installation
  17
  18 ### Releases
  19
  20 It is recommended that you run released versions of the tools. These
  21 releases can be found as git tags (e.g. `2019.1`) as well as prebuilt
  22 binaries in the [releases tab](https://github.com/dominikh/go-tools/releases).
  23
  24 The easiest way of using the releases from source is to use a Go
  25 package manager such as Godep or Go modules. Alternatively you can use
  26 a combination of `git clone -b` and `go get` to check out the
  27 appropriate tag and download its dependencies.
  28
  29
  30 ### Master
  31
  32 You can also run the master branch instead of a release. Note that
  33 while the master branch is usually stable, it may still contain new
  34 checks or backwards incompatible changes that break your build. By
  35 using the master branch you agree to become a beta tester.
  36
  37 ## Tools
  38
  39 All of the following tools can be found in the cmd/ directory. Each
  40 tool is accompanied by its own README, describing it in more detail.
  41
  42 | Tool                                               | Description                                                             |
  43 |----------------------------------------------------|-------------------------------------------------------------------------|
  44 | [keyify](cmd/keyify/)                              | Transforms an unkeyed struct literal into a keyed one.                  |
  45 | [rdeps](cmd/rdeps/)                                | Find all reverse dependencies of a set of packages                      |
  46 | [staticcheck](cmd/staticcheck/)                    | Go static analysis, detecting bugs, performance issues, and much more. |
  47 | [structlayout](cmd/structlayout/)                  | Displays the layout (field sizes and padding) of structs.               |
  48 | [structlayout-optimize](cmd/structlayout-optimize) | Reorders struct fields to minimize the amount of padding.               |
  49 | [structlayout-pretty](cmd/structlayout-pretty)     | Formats the output of structlayout with ASCII art.                      |
  50
  51 ## Libraries
  52
  53 In addition to the aforementioned tools, this repository contains the
  54 libraries necessary to implement these tools.
  55
  56 Unless otherwise noted, none of these libraries have stable APIs.
  57 Their main purpose is to aid the implementation of the tools. If you
  58 decide to use these libraries, please vendor them and expect regular
  59 backwards-incompatible changes.
  60
  61 ## System requirements
  62
  63 We support the last two versions of Go.