Skip to content

Commit 912faad

Browse files
committed
Update README
1 parent c33adb8 commit 912faad

1 file changed

Lines changed: 32 additions & 29 deletions

File tree

README.md

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ remotes::install_github("REditorSupport/languageserver")
2424

2525
## Language Clients
2626

27-
These editors are supported by installing the corresponding package.
27+
The following editors are supported by installing the corresponding extensions:
2828

29-
- VSCode: [vscode-r-lsp](https://github.com/REditorSupport/vscode-r-lsp)
29+
- VS Code: [vscode-R](https://github.com/REditorSupport/vscode-R)
3030

3131
- Atom: [atom-ide-r](https://github.com/REditorSupport/atom-ide-r)
3232

@@ -41,32 +41,32 @@ These editors are supported by installing the corresponding package.
4141
```
4242
4343
or, if you use [coc.nvim](https://github.com/neoclide/coc.nvim), you can do one of two things:
44+
45+
- Install [coc-r-lsp](https://github.com/neoclide/coc-r-lsp) with:
4446
45-
- Install [coc-r-lsp](https://github.com/neoclide/coc-r-lsp) with:
46-
47-
```vim
48-
:CocInstall coc-r-lsp
49-
```
50-
51-
- or install the languageserver package in R
52-
53-
```r
54-
install.packages("languageserver")
55-
# or install the developement version
56-
# devtools::install_github("REditorSupport/languageserver")
57-
```
58-
59-
Then add the following to your Coc config:
60-
61-
```json
62-
"languageserver": {
63-
"R": {
64-
"command": "/usr/bin/R",
65-
"args" : [ "--slave", "-e", "languageserver::run()"],
66-
"filetypes" : ["r"]
67-
}
47+
```vim
48+
:CocInstall coc-r-lsp
49+
```
50+
51+
- or install the languageserver package in R
52+
53+
```r
54+
install.packages("languageserver")
55+
# or install the developement version
56+
# remotes::install_github("REditorSupport/languageserver")
57+
```
58+
59+
Then add the following to your Coc config:
60+
61+
```json
62+
"languageserver": {
63+
"R": {
64+
"command": "/usr/bin/R",
65+
"args" : [ "--slave", "-e", "languageserver::run()"],
66+
"filetypes" : ["r"]
6867
}
69-
```
68+
}
69+
```
7070
7171
- Emacs: [lsp-mode](https://github.com/emacs-lsp/lsp-mode)
7272
@@ -123,13 +123,13 @@ settings | default | description
123123
`r.lsp.server_capabilities` | `{}` | override server capabilities defined in [capabilities.R](https://github.com/REditorSupport/languageserver/blob/master/R/capabilities.R). See FAQ below.
124124
`r.lsp.link_file_size_limit` | 16384 | maximum file size (in bytes) that supports document links
125125
126-
These settings could also specified in `.Rprofile` file via `options(languageserver.<SETTING_NAME> = <VALUE>)`. For example,
126+
These settings could also specified in `.Rprofile` file via `options(languageserver.<SETTING_NAME> = <VALUE>)`. For example,
127127
128128
```r
129129
options(languageserver.snippet_support = FALSE)
130130
```
131-
will turn off snippet support globally. LSP configuration settings are always overriden by `options()`.
132131

132+
will turn off snippet support globally. LSP configuration settings are always overriden by `options()`.
133133

134134
## FAQ
135135

@@ -144,6 +144,7 @@ Server capabilities are defined in
144144
Users could override the capabilities by specifying the LSP configuration setting
145145
`server_capabilities` or
146146
`options(languageserver.server_capabilities)` in `.Rprofile`. For example, to turn off `definitionProvider`, one could either use LSP configuration
147+
147148
```json
148149
"r": {
149150
"lsp": {
@@ -153,7 +154,9 @@ Users could override the capabilities by specifying the LSP configuration settin
153154
}
154155
}
155156
```
156-
or R options
157+
158+
or R options
159+
157160
```r
158161
options(
159162
languageserver.server_capabilities = list(

0 commit comments

Comments
 (0)