feat: add permament_wrapper option to manage wsl (#203)

Ref: #196

README.md

@@ -106,6 +106,7 @@ Yanky comes with the following defaults:
     cancel_event = "update",
     ignore_registers = { "_" },
     update_register_on_cycle = false,
+    permanent_wrapper = nil,
   },
   picker = {
     select = {
@@ -199,6 +200,7 @@ require("yanky").setup({
     cancel_event = "update",
     ignore_registers = { "_" },
     update_register_on_cycle = false,
+    permanent_wrapper = nil,
   },
   system_clipboard = {
     sync_with_ring = true,
@@ -300,6 +302,14 @@ Using the `update_register_on_cycle` option, when you cycle through the ring,
 the contents of the register used to update will be updated with the last
 content cycled.
 
+### `ring.permanent_wrapper`
+
+Default: `nil`
+
+Using the `permanent_wrapper` option, you can set a wrapper that will be used
+for every put action. This is useful if you want to add a treatment to every
+put actions (ex: remove `\r` for wsl support).
+
 ### Commands
 
 You can clear yank history using `YankyClearHistory` command.
@@ -706,7 +716,9 @@ require("substitute").setup({
   on_substitute = require("yanky.integration").substitute(),
 })
 ```
+
 or
+
 ```lua
 opts = {
   on_substitute = function() require("yanky.integration").substitute() end,
@@ -784,6 +796,22 @@ end
 
 </details>
 
+<details>
+  <summary><b>windows wsl</b></summary>
+When pasting text from windows system clipboard, there's always a ^M at the end
+of each line. Adding a permeant wrapper to remove these ^M characters when pasting
+will allows you to paste text from windows system clipboard without any issues.
+
+```lua
+require("yanky").setup({
+  ring = {
+    permanent_wrapper = require("yanky.wrappers").remove_carriage_return,
+  },
+})
+```
+
+</details>
+
 ## 🎉 Credits
 
 This plugin is mostly a lua version of [svermeulen/vim-yoink](https://github.com/svermeulen/vim-yoink)

lua/yanky.lua

@@ -97,6 +97,9 @@ function yanky.put(type, is_visual, callback)
   yanky.ring.state = nil
   yanky.ring.is_cycling = false
   yanky.ring.callback = callback or do_put
+  if yanky.config.options.ring.permament_wrapper ~= nil then
+    yanky.ring.callback = yanky.config.options.ring.permament_wrapper(yanky.ring.callback)
+  end
 
   -- On Yank event is not triggered when put from expression register,
   -- To allows cycling, we must store value here

lua/yanky/wrappers.lua

@@ -98,4 +98,23 @@ function wrappers.set_cursor_pos(pos, next)
   end
 end
 
+function wrappers.remove_carriage_return(next)
+  return function(state, callback)
+    local body = vim.fn.getreg(state.register)
+    local type = vim.fn.getregtype(state.register)
+
+    local reformated_body = body:gsub("\r", "")
+
+    vim.fn.setreg(state.register, reformated_body, type)
+
+    if nil == next then
+      callback(state)
+    else
+      next(state, callback)
+    end
+
+    vim.fn.setreg(state.register, body, type)
+  end
+end
+
 return wrappers