Snippets Go to default configuration

Blink uses the vim.snippet API by default for expanding and navigating snippets. The built-in snippets source will load friendly-snippets, if available, and load any snippets found at ~/.config/nvim/snippets/. For use with Luasnip, see the Luasnip section. For use with mini.snippets, see the mini.snippets section. For use with vim-vsnip, see the vim-vsnip section.

Friendly Snippets

When using the built-in vim.snippet snippet engine, friendly-snippets will be automatically loaded, if available (disable with friendly_snippets = false). To add snippets from a framework to a filetype use extended_filetypes.

sources = {
  providers = {
    snippets = {
      opts = {
        friendly_snippets = true, -- default

        -- see the list of frameworks in: https://github.com/rafamadriz/friendly-snippets/tree/main/snippets/frameworks
        -- and search for possible languages in: https://github.com/rafamadriz/friendly-snippets/blob/main/package.json
        -- the following is just an example, you should only enable the frameworks that you use
        extended_filetypes = {
          markdown = { 'jekyll' },
          sh = { 'shelldoc' },
          php = { 'phpdoc' },
          cpp = { 'unreal' }
        }
      }
    }
  }
}

To filter which snippets are shown, use filter_snippets which provides the filetype and name of the snippets file. This function returns true if the snippet should be included in completion results, and false if it should be filtered out.

sources = {
  providers = {
    snippets = {
      opts = {
        -- disable friendly-snippets frameworks
        filter_snippets = function(ft, file)
          return not (string.match(file, "friendly.snippets") and string.match(file, "framework"))
        end,
      }
    }
  }
}

Custom snippets

By default, the snippets source will check ~/.config/nvim/snippets for your custom snippets, but you may add additional folders via sources.providers.snippets.opts.search_paths. Currently, only VSCode style snippets are supported, but you may look into Luasnip if you'd like more advanced functionality. If you're coming from snipmate snippets, nadiamoe wrote a small tool for converting them to JSON (here be dragons! original discussion)

There's a great introduction to writing custom snippets in the nvim-scissors repo. Here's an example, using the linux/mac path for the neovim configuration:

// ~/.config/nvim/snippets/package.json
{
  "name": "personal-snippets",
  "contributes": {
    "snippets": [
      { "language": "lua", "path": "./lua.json" }
      { "language": ["typescriptreact", "javascriptreact"], "path": "./react.json" }
      { "language": "all", "path": "./all.json" }
    ]
  }
}

// ~/.config/nvim/snippets/lua.json
{
  "foo": {
    "prefix": "foo",
    "body": [
      "local ${1:foo} = ${2:bar}",
      "return ${3:baz}"
    ]
  }
}

Luasnip

{
  'saghen/blink.cmp',
  version = '1.*',
  -- `main` is untested, please open a PR if you've confirmed it works as expected
  dependencies = { 'L3MON4D3/LuaSnip', version = 'v2.*' },
  opts = {
    snippets = { preset = 'luasnip' },
    -- ensure you have the `snippets` source (enabled by default)
    sources = {
      default = { 'lsp', 'path', 'snippets', 'buffer' },
    },
  }
}

mini.snippets

{
  'saghen/blink.cmp',
  dependencies = 'echasnovski/mini.snippets',
  opts = {
    snippets = { preset = 'mini_snippets' },
    -- ensure you have the `snippets` source (enabled by default)
    sources = {
      default = { 'lsp', 'path', 'snippets', 'buffer' },
    },
  }
}

vim-vsnip

{
  'saghen/blink.cmp',
  dependencies = {'hrsh7th/vim-vsnip', 'https://codeberg.org/FelipeLema/bink-cmp-vsnip.git'},
  opts = {
    snippets = { preset = 'vsnip' },
    sources = {
      default = { 'lsp', 'path', 'snippets', 'buffer' },
    },
  }
}

Disable all snippets

sources.transform_items = function(_, items)
  return vim.tbl_filter(function(item)
    return item.kind ~= require('blink.cmp.types').CompletionItemKind.Snippet
  end, items)
end

When setting up your capabilities with lspconfig, add the following:

capabilities = require('blink.cmp').get_lsp_capabilities({
  textDocument = { completion = { completionItem = { snippetSupport = false } } },
})

Some LSPs may ignore the snippetSupport field, in which case, you need to set LSP specific options while setting them up. Some examples:

-- If you're using `opts = { ['rust-analyzer'] = { } }` in your lspconfig configuration, simply put these options in there instead

-- For `rust-analyzer`
lspconfig['rust-analyzer'].setup({
  settings = {
    ['rust-analyzer'] = {
      completion = {
        callable = {
          -- https://rust-analyzer.github.io/book/configuration.html#completion.callable.snippets
          snippets = 'add_parentheses', -- or 'none'
        },
      },
    },
  },
})

-- For `lua_ls`
lspconfig.lua_ls.setup({
  settings = {
    Lua = {
      completion = {
        callSnippet = 'Disable',
        keywordSnippet = 'Disable',
      }
    }
  }
})

Please open a PR if you know of any other LSPs that require special configuration!