cmp-lbdb

lbdb completion source for nvim-cmp. Names, emails, and email header recipient formatted completions are provided for contacts found in lbdb.

Installation

Use your favorite plugin manager:

• vim-plug

  Plug 'codybuell/cmp-lbdb'

• pathogen

  git clone https://github.com/codybuell/cmp-lbdb.git ~/.config/nvim/bundle/cmp-lbdb

• native package manager

  git clone https://github.com/codybuell/cmp-lbdb.git ~/.config/nvim/pack/bundle/opt/cmp-lbdb

  packadd! cmp-lbdb

Usage

-- setup with defaults (markdown and mail file types)
require('cmp').setup({
  -- snip...
  sources = {
    -- snip...
    { name = lbdb },
    -- snip...
  }
})

-- or alternatively, enable with overrides
require('cmp').setup({
  -- snip...
  sources = {
    -- snip...
    {
      name = 'lbdb',
      option = {
        filetypes = {
          'mail',
          'markdown',
          'gitcommit'
        },
        blacklist = {
          'user@host.com',
          '.*noreply.*',
        },
        mail_header_only = true,
        use_quotes = false,
      },
    },
    -- snip...
  }
})

Options

filetypes (type: table)

Default: { 'mail', 'markdown' }

Sets what filetypes the completion source will be made available.

blacklist (type: table)

Default: { '.*not?.?reply.*' }

The blacklist sets what emails to exclude from the completion list. The default value will catch variations of noreply, no-reply, do-not-reply, and so on. Lua pattern matching can be used.

mail_header_only (type: boolean)

Default: false

If set to true completions will only be provided when in the email header (any line stating with To:, From:, Cc:, etc) of a buffer of mail filetype. All other enabled filetypes will source completions as normal.

use_quotes (type: boolean)

Default: true

If set to true, will surround the name with double quotes such that elements are generated as "FirstName LastName" <email>. If set to false, it will not include quotes such that elements are generated as FirstName LastName <email>. Please see the RFC 5322 standard for mail header specifications.