summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruno Meneguele <bmeneg@heredoc.io>2023-07-31 18:02:57 -0300
committerBruno Meneguele <bmeneg@heredoc.io>2023-07-31 18:02:57 -0300
commit2a94af1bd7d45d8fd41e7bfdf85cba6672487e29 (patch)
treee6d7d7bbbedb0e07dc60f9346b69e3452abeebb2
parent9279d1d49064d85c5966f147b11c5e35e84d863c (diff)
downloadPerlNavigator-2a94af1bd7d45d8fd41e7bfdf85cba6672487e29.zip
README: add mention to coc-perl
Briefly mention coc-perl client extension in the coc.nvim section on README file, pointing users to its repo and a demo'ing a simple configuration file to enable PerlNavigator using coc-perl.
-rw-r--r--README.md30
1 files changed, 21 insertions, 9 deletions
diff --git a/README.md b/README.md
index 710c508..1a9c96e 100644
--- a/README.md
+++ b/README.md
@@ -152,21 +152,33 @@ require'lspconfig'.perlnavigator.setup{
### coc.nvim
-`:CocConfig`
+The configuration can be added directly to coc-settings (`:CocConfig`) like the following:
```json
-"languageserver": {
- "perlnavigator": {
- "command": "node",
- "args": [
- "/path/to/PerlNavigator/server/out/server.js",
- "--stdio"
- ],
- "filetypes": ["perl"]
+{
+ "languageserver": {
+ "perlnavigator": {
+ "command": "node",
+ "args": [
+ "/path/to/PerlNavigator/server/out/server.js",
+ "--stdio"
+ ],
+ "filetypes": ["perl"]
+ }
}
}
```
+Or the [coc-perl](https://github.com/perl-ide/coc-perl) client extension can be used, simplifying overall configuration.
+A simple configuration to enable PerlNavigator, after installing coc-perl (`:CocInstall coc-perl`), looks like:
+
+```json
+{
+ "perl.navigator.enable": true,
+ "perl.navigator.serverPath": "/path/to/PerlNavigator/server/out/server.js"
+}
+```
+
### Kate
For the Kate editor, you'll need to `Configure Kate -> LSP Client` and add a config to the `User Server Settings`. The following is an example config (this example uses the release binaries).
```json