@neo4j-cypher/language-server 2.0.0-next.1 → 2.0.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @neo4j-cypher/language-server
 
+## 2.0.0-next.3
+
+### Patch Changes
+
+- Updated dependencies [17909e3]
+  - @neo4j-cypher/language-support@2.0.0-next.2
+
+## 2.0.0-next.2
+
+### Patch Changes
+
+- Updated dependencies [a790700]
+- Updated dependencies [08db455]
+  - @neo4j-cypher/language-support@2.0.0-next.1
+
 ## 2.0.0-next.1
 
 ### Patch Changes

package/README.md

@@ -16,6 +16,8 @@ Once installed, you can run the language server using `cypher-language-server --
 
 Below you can find a few examples in Typescript on how to send messages to that server.
 
+For integrations with other editors, see [Integrating with other editors](#integrating-with-other-editors).
+
 ### Using ipc
 
 ```typescript
@@ -139,3 +141,60 @@ reader.listen((data) => {
 
 initialize();
 ```
+
+### Integrating with other editors
+
+#### Emacs
+
+##### With [lsp-mode](https://github.com/emacs-lsp/lsp-mode)
+
+As of version 8.0.1, `lsp-mode` provides built in support for the `cypher-language-server`. `lsp-mode` will connect to a `cypher-language-server` for any file ending with `.cypher`, or if you're currently in a `cypher-mode`. 
+
+If the `cypher-language-server` is not already installed, you can install the server by running `M-x lsp-install-server RET` and then selecting `cypher-ls` from the list.
+
+##### With [lsp-mode](https://github.com/emacs-lsp/lsp-mode) < 8.0.1
+
+```elisp
+(with-eval-after-load 'lsp-mode
+  (add-to-list 'lsp-language-id-configuration
+  ;; '(cypher-mode . "cypher")) ;; use this if you have a cypher-mode installed
+  '(".*cypher" . "cypher")) ;; otherwise, you can simply match on file ending with a regex
+
+(lsp-register-client
+(make-lsp-client :new-connection (lsp-stdio-connection '("cypher-language-server" "--stdio"))
+  :activation-fn (lsp-activate-on "cypher")
+  :server-id 'cypher)))
+```
+
+If you want semantic highlighting, remember to set 
+
+```elisp
+(setq lsp-semantic-tokens-enable t)
+```
+
+##### With [eglot](https://joaotavora.github.io/eglot/)
+
+As of Emacs 29, `eglot` is built in. In `eglot`, a language server needs to be associate with a specific major mode. Install any available `cypher-mode` in order to get the server running with `eglot`. Note also that `eglot` does not support semantic highlighting.
+
+```elisp
+(add-to-list 'Eglot-server-programs '((cypher-mode) "cypher-language-server" "--stdio")))
+```
+
+#### Neovim
+
+##### With [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)
+
+There is built-in support for the `cypher-language-server` in the plugin ([cypher_ls](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#cypher_ls)).
+
+Activate the language server support in your config file.
+```lua
+require('lspconfig').cypher_ls.setup{}
+```
+
+The language server is registered for _cypher_ files.
+To make neovim aware of this type, add a file to your _neovim-configuration-path/ftdetect_ (if it does not exist, create one) folder, e.g. _cypher.vim_, defining the file suffix and file type.
+
+```vim
+au BufRead,BufNewFile *.cypher                set filetype=cypher
+```
+