summaryrefslogtreecommitdiff
path: root/cli/lsp/README.md
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2020-12-07 21:46:39 +1100
committerGitHub <noreply@github.com>2020-12-07 21:46:39 +1100
commit301d3e4b6849d24154ac2d65c00a9b30223d000e (patch)
treeab3bc074493e6c9be8d1875233bc141bdc0da3b4 /cli/lsp/README.md
parentc8e9b2654ec0d54c77bb3f49fa31c3986203d517 (diff)
feat: add mvp language server (#8515)
Resolves #8400
Diffstat (limited to 'cli/lsp/README.md')
-rw-r--r--cli/lsp/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/cli/lsp/README.md b/cli/lsp/README.md
new file mode 100644
index 000000000..dcc953273
--- /dev/null
+++ b/cli/lsp/README.md
@@ -0,0 +1,23 @@
+# Deno Language Server
+
+The Deno Language Server provides a server implementation of the
+[Language Server Protocol](https://microsoft.github.io/language-server-protocol/)
+which is specifically tailored to provide a _Deno_ view of code. It is
+integrated into the command line and can be started via the `lsp` sub-command.
+
+> :warning: The Language Server is highly experimental and far from feature
+> complete.
+
+This document gives an overview of the structure of the language server.
+
+## Acknowledgement
+
+The structure of the language server was heavily influenced and adapted from
+[`rust-analyzer`](https://rust-analyzer.github.io/).
+
+## Structure
+
+When the language server is started, a `ServerState` instance is created which
+holds all the state of the language server, as well as provides the
+infrastructure for receiving and sending notifications and requests from a
+language server client.