README.md

nix-cmp

This is a source for the nvim-cmp plugin to try and provide auto-completion in nix files.

TODO

• turn this into a proper nvim module so I can install it using lazy
• improve perf: things will be loaded on the first completion so that first occurrence can be slow

Builtins completion

We provide completion for builtins, pkgs and lib (or pkgs.lib) based on syntax: any time you input verbatim builtins. or the other triggers, completion will fire. A future improvement would only fire on the "actual" builtins, pkgs and lib (and not e.g. for a function argument named in the same way) and not on every verbatim occurrences of them

The list is built at runtime using nix-instantiate.

Setup

• put the nix-cmp.lua file in a know location like ~/.config/nvim/lua
• register the source before calling nvim-cmp setup function
• enable it on nix file only

Here is one I update my config

-- configuration of nvim-cmp
local cmp = require('cmp')

-- add that first
cmp.register_source('nix-cmp', require('nix-cmp'))

cmp.setup({
  -- your normal setup config here
  -- ...

  -- my "general" cmp config
  sources = cmp.config.sources({
      { name = 'nvim_lsp' },
    }, {
      { name = 'path' },
      { name = 'buffer' },
    }),
    experimental = {
      ghost_text = true,
    },
})

-- specific config for .nix files
cmp.setup.filetype('nix', {
    sources = cmp.config.sources({
      { name = 'nvim_lsp' },
      { name = 'nix-cmp' }
    }, {
      { name = 'buffer' },
    })
})