From 7bb31b5283ceeebc8cd89287d71818a0a9cf6fc1 Mon Sep 17 00:00:00 2001 From: William Boman Date: Fri, 3 Sep 2021 21:00:43 +0200 Subject: clean up README a bit --- ADAPTERS.md | 16 ++++++++++++++++ README.md | 15 --------------- 2 files changed, 16 insertions(+), 15 deletions(-) create mode 100644 ADAPTERS.md diff --git a/ADAPTERS.md b/ADAPTERS.md new file mode 100644 index 00000000..cf094ae2 --- /dev/null +++ b/ADAPTERS.md @@ -0,0 +1,16 @@ +# Adapters (experimental) + +The idea with the adapter API is to provide simple interfaces that allow for a richer LSP experience by combining the +functionalities of multiple plugins. + +(make sure to only attempt connecting adapters once the plugin(s) involved have been loaded) + +## [kyazdani42/nvim-tree.lua](https://github.com/kyazdani42/nvim-tree.lua) + +```lua +require'nvim-lsp-installer.adapters.nvim-tree'.connect() +``` + +Supported capabilities: + +- `_typescript.applyRenameFile`. Automatically executes the rename file client request when renaming a node. diff --git a/README.md b/README.md index 7efeebe9..754547f2 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ LSP servers locally (inside `:echo stdpath("data")`). On top of just providing commands for installing & uninstalling LSP servers, it: - provides configurations for servers that aren't supported by nvim-lspconfig (`eslint`) -- provides Lua APIs for non-standard LSP functionalities, for example `_typescript.applyRenameFile` - has support for a variety of different install methods (e.g., [google/zx](https://github.com/google/zx)) - common install tasks are abstracted behind Lua APIs - supports Windows for a majority of server installations @@ -148,20 +147,6 @@ end You can create your own installers by using the same APIs nvim-lsp-installer itself uses. Refer to [CUSTOM_SERVERS.md](./CUSTOM_SERVERS.md) for more information. -## Adapters (experimental) - -Make sure to only attempt connecting adapters once the plugin(s) involved have been loaded. - -### [kyazdani42/nvim-tree.lua](https://github.com/kyazdani42/nvim-tree.lua) - -```lua -require'nvim-lsp-installer.adapters.nvim-tree'.connect() -``` - -Supported capabilities: - -- `_typescript.applyRenameFile`. Automatically executes the rename file client request when renaming a node. - ## Logo Illustrations in the logo are derived from [@Kaligule](https://schauderbasis.de/)'s "Robots" collection. -- cgit v1.2.3-70-g09d2