codedownio / languageserver Goto Github PK

View Code? Open in Web Editor NEW

This project forked from reditorsupport/languageserver

0.0 2.0 0.0 230 KB

An implementation of the Language Server Protocol for R

License: Other

R 87.70% C 12.30%

languageserver's Introduction

languageserver: An implementation of the Language Server Protocol for R

languageserver is an implement of the Microsoft's Language Server Protocol for the language of R.

It is released on CRAN and can be easily installed by

install.packages("languageserver")

The development version of languageserver could be installed by running the following in R

source("https://install-github.me/REditorSupport/languageserver")

Rmarkdown

The R package knitr is required to enable languageserver for Rmarkdown files. languageserver doesn't specify knitr as a dependency however, users may need to install it manually.

Language Clients

These editors are supported by installing the corresponding package.

VSCode: vscode-r-lsp
Atom: atom-ide-r
Sublime Text: R-IDE
Vim/NeoVim: LanguageClient-neovim with settings

let g:LanguageClient_serverCommands = {
    \ 'r': ['R', '--slave', '-e', 'languageserver::run()'],
    \ }

EMacs: lsp-mode with settings

(lsp-define-stdio-client lsp-R "R"
                         (lambda () default-directory)
			 '("R" "--slave" "-e" "languageserver::run()"))
(add-hook 'R-mode-hook #'lsp-R-enable)

Services Implemented

languageserver is still under active development, the following services have been implemented:

Diagnostics settings

User can specify the default linters in .Rprofile. For example,

setHook(
    packageEvent("languageserver", "onLoad"),
    function(...) {
        options(languageserver.default_linters = lintr::with_defaults(
            line_length_linter = lintr::line_length_linter(100),
            object_usage_linter = NULL,
            object_length_linter = NULL,
            object_name_linter = NULL,
            commented_code_linter = NULL
        ))
    }
)