nvim-fundo's Introduction

nvim-fundo

The goal of nvim-fundo is to make Neovim's undo file become stable and useful.

fundo-demo.mp4

WIP. If you like this plugin, star it to let me speed up to end WIP state.

Features

Restore undo history even if the file's content has been changed outside Neovim
Limit size for archives

TODO Features

Restore undo history even if the file has been moved
Support useful use cases for undo file

Quickstart

Requirements

Neovim 0.7.2 or later

Installation

Install with Packer.nvim:

use {
    'kevinhwang91/nvim-fundo', requires = 'kevinhwang91/promise-async',
     run = function() require('fundo').install() end
}

Minimal configuration

use {
    'kevinhwang91/nvim-fundo', requires = 'kevinhwang91/promise-async',
     run = function() require('fundo').install() end
}

vim.o.undofile = true
require('fundo').setup()

Usage

Use undo file as usual.

Documentation

How does nvim-undo keep the undo history?

Fundo will keep the latest files as archives, in other words, it takes additional space in your disk. If the BufReadPost event is fired, it will validate the undo file and restore it if necessary.

Setup and description

{
    archives_dir = {
        description = [[The directory to store the archives]],
        default = vim.fn.stdpath('cache') .. path.separator .. 'fundo'
    },
    limit_archives_size = {
        description = [[Limit the archives directory size, unit is MB(megabyte), elder files will be
        removed based on their modified time]],
        default = 512
    }
}

:h fundo may help you to get the all default configuration.

API

fundo.lua

Run tests

make test

Feedback

If you get an issue or come up with an awesome idea, don't hesitate to open an issue in github.
If you think this plugin is useful or cool, consider rewarding it a star.