feat: support configuring clipboard register for snippets

Closes #800
Saghen · Dec 29, 2024 · 8f51a4e · 8f51a4e
1 parent c593e83
commit 8f51a4e
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 13 deletions.
diff --git a/docs/configuration/reference.md b/docs/configuration/reference.md
@@ -463,6 +463,8 @@ sources.providers = {
       get_filetype = function(context)
         return vim.bo.filetype
       end
+      -- Set to '+' to use the system clipboard, or '"' to use the unnamed register
+      clipboard_register = nil,
     }
   },
   luasnip = {

diff --git a/lua/blink/cmp/snippets.lua b/lua/blink/cmp/snippets.lua
diff --git a/lua/blink/cmp/sources/snippets/builtin.lua b/lua/blink/cmp/sources/snippets/builtin.lua
@@ -15,7 +15,7 @@ function builtin.lazy.TM_DIRECTORY() return vim.fn.expand('%:p:h') end
 
 function builtin.lazy.TM_FILEPATH() return vim.fn.expand('%:p') end
 
-function builtin.lazy.CLIPBOARD() return vim.fn.getreg(vim.v.register, true) end
+function builtin.lazy.CLIPBOARD(opts) return vim.fn.getreg(opts.clipboard_register or vim.v.register, true) end
 
 local function buf_to_ws_part()
   local LSP_WORSKPACE_PARTS = 'LSP_WORSKPACE_PARTS'

diff --git a/lua/blink/cmp/sources/snippets/init.lua b/lua/blink/cmp/sources/snippets/init.lua
@@ -1,19 +1,20 @@
 --- @class blink.cmp.SnippetsOpts
---- @field friendly_snippets boolean
---- @field search_paths string[]
---- @field global_snippets string[]
---- @field extended_filetypes table<string, string[]>
---- @field ignored_filetypes string[]
---- @field get_filetype fun(context: blink.cmp.Context): string
+--- @field friendly_snippets? boolean
+--- @field search_paths? string[]
+--- @field global_snippets? string[]
+--- @field extended_filetypes? table<string, string[]>
+--- @field ignored_filetypes? string[]
+--- @field get_filetype? fun(context: blink.cmp.Context): string
+--- @field clipboard_register? string
 
 local snippets = {}
 
 function snippets.new(opts)
+  --- @type blink.cmp.SnippetsOpts
   opts = opts or {}
   local self = setmetatable({}, { __index = snippets })
   --- @type table<string, blink.cmp.CompletionItem[]>
   self.cache = {}
-  --- @type blink.cmp.SnippetsOpts
   self.registry = require('blink.cmp.sources.snippets.registry').new(opts)
   self.get_filetype = opts.get_filetype or function() return vim.bo.filetype end
   return self

diff --git a/lua/blink/cmp/sources/snippets/registry.lua b/lua/blink/cmp/sources/snippets/registry.lua
@@ -2,10 +2,10 @@
 --- for the original implementation
 --- Original License: MIT
 
----@class blink.cmp.Snippet
----@field prefix string
----@field body string[] | string
----@field description? string
+--- @class blink.cmp.Snippet
+--- @field prefix string
+--- @field body string[] | string
+--- @field description? string
 
 local registry = {
   builtin_vars = require('blink.cmp.sources.snippets.builtin'),
@@ -18,6 +18,8 @@ local default_config = {
   global_snippets = { 'all' },
   extended_filetypes = {},
   ignored_filetypes = {},
+  --- @type string?
+  clipboard_register = nil,
 }
 
 --- @param config blink.cmp.SnippetsOpts
@@ -127,7 +129,10 @@ function registry:expand_vars(snippet)
       if eager_vars[data.name] then
         resolved_snippet = resolved_snippet:gsub('%$[{]?(' .. data.name .. ')[}]?', eager_vars[data.name])
       elseif lazy_vars[data.name] then
-        resolved_snippet = resolved_snippet:gsub('%$[{]?(' .. data.name .. ')[}]?', lazy_vars[data.name]())
+        resolved_snippet = resolved_snippet:gsub(
+          '%$[{]?(' .. data.name .. ')[}]?',
+          lazy_vars[data.name]({ clipboard_register = self.config.clipboard_register })
+        )
       end
     end
   end