aboutsummaryrefslogtreecommitdiff
path: root/gopls/internal/lsp/fake/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'gopls/internal/lsp/fake/doc.go')
-rw-r--r--gopls/internal/lsp/fake/doc.go19
1 files changed, 19 insertions, 0 deletions
diff --git a/gopls/internal/lsp/fake/doc.go b/gopls/internal/lsp/fake/doc.go
new file mode 100644
index 000000000..6051781de
--- /dev/null
+++ b/gopls/internal/lsp/fake/doc.go
@@ -0,0 +1,19 @@
+// Copyright 2020 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package fake provides fake implementations of a text editor, LSP client
+// plugin, and Sandbox environment for use in tests.
+//
+// The Editor type provides a high level API for text editor operations
+// (open/modify/save/close a buffer, jump to definition, etc.), and the Client
+// type exposes an LSP client for the editor that can be connected to a
+// language server. By default, the Editor and Client should be compliant with
+// the LSP spec: their intended use is to verify server compliance with the
+// spec in a variety of environment. Possible future enhancements of these
+// types may allow them to misbehave in configurable ways, but that is not
+// their primary use.
+//
+// The Sandbox type provides a facility for executing tests with a temporary
+// directory, module proxy, and GOPATH.
+package fake