Skip to main content

Configuration recipes

Here are some useful configurations for care.

Common fields​

This section lists some commonly uses fields in which users might be interested.

Source name​

You can access the name of the source form which the entry was completed with the source_name or the source_display_name field in the additional data passed to the format_entry function. The display name will often be significantly longer so it's recommended to use source_name.

Labels and shortcuts​

This configuration will add labels to your items and allow to select them with ctrl+label.

local labels = {"1", "2", "3", "4", "5", "6", "7", "8", "9"}

-- Add this to formatting

{ {
    " " .. require("care.presets.utils").label_entries(labels)(entry, data) .. " ",
    "Comment",
}, },

-- Keymappings
for i, label in ipairs(labels) do
    vim.keymap.set("i", "<c-"..label..">", function()
        require("care").api.select_visible(i)
        -- If you also want to confirm the entry
        require("care").api.confirm()
    end)
end

Access Documentation​

You can use these function to access documentation. This e.g. allows to copy it to somewhere for reference or to click links in it easily.

They have to be called while the documentation window of care is actually open.

Open in split​

This function opens the documentation in a split window.

local documentation = require("care").api.get_documentation()
if #documentation == 0 then
    return
end
local old_win = vim.api.nvim_get_current_win()
vim.cmd.wincmd("s")
local buf = vim.api.nvim_create_buf(false, true)
vim.bo[buf].ft = "markdown"
vim.api.nvim_buf_set_lines(buf, 0, -1, false, documentation)
vim.api.nvim_win_set_buf(0, buf)
vim.api.nvim_set_current_win(old_win)

Copy to clipboard​

This function copies the documentation to the clipboard (or any other register).

local documentation = require("care").api.get_documentation()
if #documentation == 0 then
    return
end
vim.fn.setreg("+", table.concat(documentation, "\n"))

Integrations for icons​

There are various integrations with different plugins for icons in care.nvim

Mini.icons​

Install mini.icons as described in the readme. (Don't forget to call require"mini.icons".setup()!).

Then use the following configuration for care.

require("care").setup({
    ui = {
        type_icons = "mini.icons"
    }
})

Mini.icons also allows you to use ascii icons by using { style = "ascii" } in the setup.

Lspkind.nvim​

Install lspkind.nvim as described in the readme.

Then use the following configuration for care.

require("care").setup({
    ui = {
        type_icons = "lspkind"
    }
})

Manual completion like builtin neovim​

You can use filters to only complete certain sources. This can be used to create a behavior like builtin neovim.

There are always certain sources required for the mappings.

You likely also want to set completion_events to an empty table {} to disable autocompletion if you want this behavior.

LSP Omnifunc​

You can create something similar to the behavior of setting omnifunc to vim.lsp.omnifunc() like this:

-- Source: none, is builtin
vim.keymap.set("i", "<c-x><c-o>", function()
    require("care").api.complete(function(name)
        return name == "lsp"
    end)
end)

Paths​

-- Source: "hrsh7th/cmp-path" (requires "max397574/care-cmp")
-- Limitations: In comparison to builtin completion the pattern to find filenames is different
-- So you have to use e.g. `./in` to complete `init.lua` instead of just `in` like builting completion

vim.keymap.set("i", "<c-x><c-f>", function()
    require("care").api.complete(function(name)
        return name == "cmp_path"
    end)
end)

Buffer keywords​

-- Source: "hrsh7th/cmp-buffer" (requires "max397574/care-cmp")
-- Limitations: Searches in whole buffers, forwards and backwards cursor

-- same for "<c-x><c-n>", "<c-x><c-p>"
vim.keymap.set("i", "<c-x><c-i>", function()
    require("care").api.complete(function(name)
        return name == "cmp_buffer"
    end)
end)

Buffer lines​

-- Source: "amarakon/nvim-cmp-buffer-lines" (requires "max397574/care-cmp")
-- Limitations: Not tested enough to know

vim.keymap.set("i", "<c-x><c-l>", function()
    require("care").api.complete(function(name)
        return name == "cmp_buffer-lines"
    end)
end)

Spelling​

-- Source: "f3fora/cmp-spell" (requires "max397574/care-cmp")
-- Limitations: Not tested enough to know

vim.keymap.set("i", "<c-x><c-s>", function()
    require("care").api.complete(function(name)
        return name == "cmp_spell"
    end)
end)

Reverse keybindings for reversed menu​

When using "away-from-cursor" as sorting_direction in the configuration the menu can be reversed. The select_{next, prev} mappings will still go in the same direction though. If you always want to use select_next to select the entry with a lower match than current one you can use mappings like this:

vim.keymap.set("i", "<c-n>", function()
    if require("care").api.is_reversed() then
        require("care").api.select_prev()
    else
        require("care").api.select_next()
    end
end)

vim.keymap.set("i", "<c-p>", function()
    if require("care").api.is_reversed() then
        require("care").api.select_next()
    else
        require("care").api.select_prev()
    end
end)

Use with nvim-autopairs​

"windwp/nvim-autopairs",
lazy = false,
config = function()
    local npairs = require("nvim-autopairs")
    npairs.setup({ map_cr = false })
    vim.keymap.set("i", "<cr>", function()
        if require("care").api.is_open() then
            require("care").api.confirm()
        else
            vim.fn.feedkeys(require("nvim-autopairs").autopairs_cr(), "in")
        end
    end)
end,

Common Configurations​

Luasnip and friendly-snippets​

Lazy.nvim Example
{
    "max397574/care.nvim",
    dependencies = {
        "max397574/care-cmp",
        "saadparwaiz1/cmp_luasnip",
        "rafamadriz/friendly-snippets",
        "L3MON4D3/LuaSnip",
    },
    config = function()
        ...
    end
}

Then you can use the following configuration to use luasnip for snippet completion and to load the friendly-snippets snippets.

config = function()
    require("luasnip.loaders.from_vscode").lazy_load()
    require("care").setup({
        snippet_expansion = function(body)
            require("luasnip").lsp_expand(body)
        end,
        ...
    })
end