Usage

Installation

{"nvim-telescope/telescope.nvim",dependencies= {"nvim-lua/plenary.nvim","debugloop/telescope-undo.nvim",  },config=function()require("telescope").setup({-- the rest of your telescope config goes hereextensions= {undo= {-- telescope-undo.nvim config, see below        },-- other extensions:-- file_browser = { ... }      },    })require("telescope").load_extension("undo")-- optional: vim.keymap.set("n", "<leader>u", "<cmd>Telescope undo<cr>")end,},

{"debugloop/telescope-undo.nvim",dependencies= {-- note how they're inverted to above example    {"nvim-telescope/telescope.nvim",dependencies= {"nvim-lua/plenary.nvim"},    },  },keys= {    {-- lazy style key map"<leader>u","<cmd>Telescope undo<cr>",desc="undo history",    },  },opts= {-- don't use `defaults = { }` here, do this in the main telescope specextensions= {undo= {-- telescope-undo.nvim config, see below      },-- no other extensions here, they can have their own spec too    },  },config=function(_,opts)-- Calling telescope's setup from multiple specs does not hurt, it will happily merge the-- configs for us. We won't use data, as everything is in it's own namespace (telescope-- defaults, as well as each extension).require("telescope").setup(opts)require("telescope").load_extension("undo")end,},

" Directly by calling it through Telescope's extension interface:" using lua:luarequire("telescope").extensions.undo.undo()" using custom options for just this call:luarequire("telescope").extensions.undo.undo({ side_by_side= true })" using legacy Vim script:Telescopeundo" Using the optional mapping:" using lua:luavim.keymap.set("n","<leader>u","<cmd>Telescope undo<cr>")" using legacy Vim script:nmap<leader>u<cmd>Telescope undo<cr>

Configuration

opts= {extensions= {undo= {use_delta=true,use_custom_command=nil,-- setting this implies `use_delta = false`. Accepted format is: { "bash", "-c", "echo '$DIFF' | delta" }side_by_side=false,vim_diff_opts= {ctxlen=vim.o.scrolloff,      },entry_format="state #$ID, $STAT, $TIME",time_format="",saved_only=false,    },  },},

opts= {extensions= {undo= {side_by_side=true,layout_strategy="vertical",layout_config= {preview_height=0.8,      },    },  },}

Mappings

require("telescope").setup({extensions= {undo= {mappings= {i= {          ["<cr>"]=require("telescope-undo.actions").yank_additions,          ["<S-cr>"]=require("telescope-undo.actions").yank_deletions,          ["<C-cr>"]=require("telescope-undo.actions").restore,-- alternative defaults, for users whose terminals do questionable things with modified <cr>          ["<C-y>"]=require("telescope-undo.actions").yank_deletions,          ["<C-r>"]=require("telescope-undo.actions").restore,        },n= {          ["y"]=require("telescope-undo.actions").yank_additions,          ["Y"]=require("telescope-undo.actions").yank_deletions,          ["u"]=require("telescope-undo.actions").restore,        },      },    },  },})

Important

Note how above example uses the call to telescope'ssetup(). This is due to the fact thatdirectly requiring these actions needstelescope-undo to be available already, which it is notinside lazy'sopts key when using above "standalone" spec. See the next example for how to do itinsideopts.

opts= {extensions= {undo= {mappings= {-- Wrapping the actions inside a function prevents the error due to telescope-undo being not-- yet loaded.i= {          ["<cr>"]=function(bufnr)returnrequire("telescope-undo.actions").yank_larger(bufnr)end,        },n= {          ["y"]=function(bufnr)returnrequire("telescope-undo.actions").yank_larger(bufnr)end,        },      },    },  },}

opts= {extensions= {undo= {mappings= {i= {          ["<C-y>"]=false,        },      },    },  },}

Contributions