Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jalvesaq/cmp-nvim-r


https://github.com/jalvesaq/cmp-nvim-r

nvim-cmp r

Last synced: 15 days ago
JSON representation

Awesome Lists containing this project

README 

        
# cmp-nvim-r



Completion source for [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) using [Nvim-R](https://github.com/jalvesaq/Nvim-R) as backend.



## Installation



Use a plugin manager such as [vim-plug](https://github.com/junegunn/vim-plug)

or [packer](https://github.com/wbthomason/packer.nvim).



## Setup



Register the source for `nvim-cmp`:



```lua

require'cmp'.setup {

  sources = {

    { name = 'cmp_nvim_r' },

  }

}

```



## Configuration



### cmp-nvim-r



`cmp-nvim-r` has the following options:



  - `filetypes`: The list of file types for which the source should be enabled.

    Default: `{'r', 'rmd', 'quarto', 'rnoweb', 'rhelp'}`



  - `doc_width`: The expected maximum width of the floating documentation

    window. This value is used to format the usage section of function

    documentation. Arguments are concatenated, but line breaks are inserted

    between arguments before the line reaches the number of columns defined by

    `doc_width`. Default: `58`.



    See also the option `maxwidth` in [lspkind.nvim](https://github.com/onsails/lspkind.nvim).



  - `fun_data_1`: List of functions that receive a `data.frame` as its first

    argument and for which the `data.frame`s columns names should be

    completed. This option is overridden by `g:R_fun_data_1`. Default:

    `{'select', 'rename', 'mutate', 'filter'}`.



  - `fun_data_2`: Dictionary with parent functions as keys. The value of each

    key is a list of functions that are expected to be nested in the parent

    function which receives a data.frame as its first arguments. Column names

    of the `data.frame` are completed as arguments of the nested function.

    This option is overridden by `g:R_fun_data_1`. Default:

    `{ggplot = {'aes'}, with = {'*'}}`.



  - `quarto_intel`: Path to `yaml-intelligence-resources.json` which is part

    of `quarto` application and has all necessary information for completion

    of valid YAML options in an Quarto document.  This option is overridden by

    `g:R_quarto_intel`. Default: `nil` (`cmp-nvim-r` will try to find the file).



Below is an example of how to set theses options:



```lua

require("cmp_nvim_r").setup({

  filetypes = {"r", "rmd", "quarto"},

  doc_width = 58

  quarto_intel = "~/Downloads/quarto-1.1.251/share/editor/tools/yaml/yaml-intelligence-resources.json"

  })

```



### nvim-cmp



The source `cmp_nvim_r` does not require any special configuration of

`nvim-cmp` to work, and people have different preferences and workflows.

Anyway, I share below what worked best for me:



  - `cmp-nvim-r` sets the field `sortText` of completed items as "0" for

    function arguments and "9" for everything else. This means that function

    arguments will always be at the top of the list of suggestions if you put

    `cmp.config.compare.sort_text` at the top of list of compare `nvim-cmp`

    functions.



  - Install a Nerd font and install and configure your terminal emulator to

    use it. Then install [lspkind.nvim](https://github.com/onsails/lspkind.nvim)

    to have symbols representing the kind of object whose name is being completed.



  - The names of kind of objects are generic names of the LSP server protocol

    and do not match the classes of R objects. So, it is better to hide the

    names and display only the symbols.



An example following the above suggestions:



```lua

cmp.setup({

    formatting = {

        fields = {'abbr', 'kind', 'menu'},

        format = lspkind.cmp_format({

            mode = 'symbol', -- show only symbol annotations

            maxwidth = 50, -- prevent the popup from showing more than provided characters

            ellipsis_char = '...', -- the truncated part when popup menu exceed maxwidth

            before = function(entry, item)

                local menu_icon = {

                    nvim_lsp = '',

                    vsnip = '',

                    path = '',

                    cmp_zotcite = 'z',

                    cmp_nvim_r = 'R'

                }

                item.menu = menu_icon[entry.source.name]

                return item

            end,

        })

    },

    sources = cmp.config.sources({

        { name = 'vsnip' },

        { name = 'cmp_zotcite' },

        { name = 'cmp_nvim_r' },

        { name = 'nvim_lsp' },

        { name = 'path', option = { trailing_slash = true } },

    }),

})

```

### languageserver



Since `cmp-nvim-r` and the R package `languageserver` provide completions for

the same code, and completions from the `languageserver` might be the first

ones to be displayed by `nvim-cmp`, you may want to put this in your `~/.Rprofile`:



```r

# Disable completion from the language server

options(languageserver.server_capabilities =

        list(completionProvider = FALSE, completionItemResolve = FALSE))



```