mvnsearch.nvim

Convenient way to add dependencies to your Java/Kotlin project using Neovim with Telescope.

It uses REST API from Maven Central Repository

Dependencies

• Telescope - after all this is just another telescope extension
• xml2lua - for parsing xml response and working with pom.xml
• plenary.nvim - specifically plenary.curl for making request
• find, fd or ripgrep - for finding build scripts [Optional]

Installation

Using packer.nvim:

use {
    'nvim-telescope/telescope.nvim',
    requires = {
        { 'nvim-lua/plenary.nvim' },
        {
            'Iamnotagenius/mvnsearch.nvim',
            rocks = {
                -- It is important to specify this version since the latest version of xml2lua on luarocks
                -- has some bugs, see https://github.com/manoelcampos/xml2lua/issues/87
                'xml2lua 1.5-1'
            }
        }
    },
}

Usage

This extension provides mvnsearch picker and :MvnSearch command with query argument. So you can use:

• :Telescope mvnsearch query=spring
• :MvnSearch spring

Of course you also can use Telescope's api to call mvnsearch picker from lua.

Features

You can:

• search through packages
• make new queries from prompt
• yank dependecy strings...
• ...or insert them directly to gradle.build(.kts) or pom.xml
• multi-select that persists through pages and queries

Insertion works like this:

1. mvnsearch searches for build script in vim's cwd and determines how to format a package.
2. Inserts formatted package to build script (currently using macro for gradle).
3. If it does not find any build script, it fallbacks to yanking.

All mappings are described in Configuration

Queries are paginated, so if you didn't find desired package, try to go to next page

Configuration

You can configure this extension just like other ones using telescope.setup (default configuration is used in this example):

local mvnsearch = telescope.extensions.mvnsearch

telescope.setup {
    -- ...
    extensions = {
        -- ...
        mvnsearch = {
            -- Macro for pasting dependecy string in build.gradle(.kts); {depstr} is replaced with dependecy string
            gradle_macro = '/dependencies<CR>$%O{depstr}<Esc>==:w<CR>',
            yank_register = 'd', -- Register for dependecy string to yank to
            preferred_build_system = mvnsearch.inserters.kotlin_gradle, -- Fallback format of dependecy string
            default_action = mvnsearch.actions.insert_to_build_script, -- Action on select_default
            find_command = mvnsearch.defaults.find_command, -- find command used to find build scripts
            mappings = {
                n = {
                    y = mvnsearch.actions.yank,
                    n = mvnsearch.actions.next_page,
                    p = mvnsearch.actions.prev_page,
                    o = mvnsearch.actions.insert_to_build_script
                },
                i = {
                    ['<C-y>'] = mvnsearch.actions.yank,
                    ['<C-n>'] = mvnsearch.actions.next_page,
                    ['<C-p>'] = mvnsearch.actions.prev_page,
                    ['<C-o>'] = mvnsearch.actions.insert_to_build_script,
                    ['<C-s>'] = mvnsearch.actions.new_query
                }
            }
            rows = 30, -- Items per page
            -- Determines declaration string (<?xml ...?>) in pom.xml. It can be either:
            -- a string - simply replaces ...
            -- a table - inserts key="value" for each entry in table to declaration string
            -- a function - called with a filename argument, should return declaration string or table
            xml_declaration = {
                version = "1.0",
                encoding = "UTF-8"
            }
        }
    }
}

TODO

• Maven support
• Asynchronous requests (but only for mappings as creating a picker requires calling a vimL function which cannot be executed in async context)
• Multiple project files
• Version selection
• Multi-select support