.config/coc/extensions/coc-go-data/tools/pkg/mod/golang.org/x/tools/gopls@v0.6.9/README.md

   1 # `gopls`, the Go language server
   2
   3 [![PkgGoDev](https://pkg.go.dev/badge/golang.org/x/tools/gopls)](https://pkg.go.dev/golang.org/x/tools/gopls)
   4
   5 `gopls` (pronounced "Go please") is the official Go [language server] developed
   6 by the Go team. It provides IDE features to any [LSP]-compatible editor.
   7
   8 <!--TODO(rstambler): Add gifs here.-->
   9
  10 You should not need to interact with `gopls` directly--it will be automatically
  11 integrated into your editor. The specific features and settings vary slightly
  12 by editor, so we recommend that you proceed to the [documentation for your
  13 editor](#editors) below.
  14
  15 ## Editors
  16
  17 To get started with `gopls`, install an LSP plugin in your editor of choice.
  18
  19 * [VSCode](https://github.com/golang/vscode-go/blob/master/README.md)
  20 * [Vim / Neovim](doc/vim.md)
  21 * [Emacs](doc/emacs.md)
  22 * [Atom](https://github.com/MordFustang21/ide-gopls)
  23 * [Sublime Text](doc/subl.md)
  24 * [Acme](https://github.com/fhs/acme-lsp)
  25
  26 If you use `gopls` with an editor that is not on this list, please let us know
  27 by [filing an issue](#new-issue) or [modifying this documentation](doc/contributing.md).
  28
  29 ## Installation
  30
  31 For the most part, you should not need to install or update `gopls`. Your
  32 editor should handle that step for you.
  33
  34 If you do want to get the latest stable version of `gopls`, change to any
  35 directory that is both outside of your `GOPATH` and outside of a module (a temp
  36 directory is fine), and run:
  37
  38 ```sh
  39 GO111MODULE=on go get golang.org/x/tools/gopls@latest
  40 ```
  41
  42 **NOTE**: Do not use the `-u` flag, as it will update your dependencies to
  43 incompatible versions.
  44
  45 Learn more in the [advanced installation
  46 instructions](doc/advanced.md#installing-unreleased-versions).
  47
  48 ## Setting up your workspace
  49
  50 `gopls` supports both Go module and GOPATH modes, but if you are working with
  51 multiple modules or uncommon project layouts, you will need to specifically
  52 configure your workspace. See the [Workspace document](doc/workspace.md) for
  53 information on supported workspace layouts.
  54
  55 ## Configuration
  56
  57 You can configure `gopls` to change your editor experience or view additional
  58 debugging information. Configuration options will be made available by your
  59 editor, so see your [editor's instructions](#editors) for specific details. A
  60 full list of `gopls` settings can be found in the [Settings documentation](doc/settings.md).
  61
  62 ### Environment variables
  63
  64 `gopls` inherits your editor's environment, so be aware of any environment
  65 variables you configure. Some editors, such as VS Code, allow users to
  66 selectively override the values of some environment variables.
  67
  68 ## Troubleshooting
  69
  70 If you are having issues with `gopls`, please follow the steps described in the
  71 [troubleshooting guide](doc/troubleshooting.md).
  72
  73 ## Supported Go versions and build systems
  74
  75 `gopls` follows the
  76 [Go Release Policy](https://golang.org/doc/devel/release.html#policy),
  77 meaning that it officially supports the last 2 major Go releases. Though we
  78 try not to break older versions, we do not prioritize issues only affecting
  79 legacy Go releases.
  80
  81 `gopls` currently only supports the `go` command, so if you are using a
  82 different build system, `gopls` will not work well. Bazel support is currently
  83 blocked on
  84 [bazelbuild/rules_go#512](https://github.com/bazelbuild/rules_go/issues/512).
  85
  86 ## Additional information
  87
  88 * [Features](doc/features.md)
  89 * [Command-line interface](doc/command-line.md)
  90 * [Advanced topics](doc/advanced.md)
  91 * [Contributing to `gopls`](doc/contributing.md)
  92 * [Integrating `gopls` with an editor](doc/design/integrating.md)
  93 * [Design requirements and decisions](doc/design/design.md)
  94 * [Implementation details](doc/design/implementation.md)
  95 * [Open issues](https://github.com/golang/go/issues?q=is%3Aissue+is%3Aopen+label%3Agopls)
  96
  97 [language server]: https://langserver.org
  98 [LSP]: https://microsoft.github.io/language-server-protocol/
  99 [Gophers Slack]: https://gophers.slack.com/