dial.nvim

NOTICE: This plugin is work-in-progress yet. User interface is subject to change without notice.

Extended increment/decrement plugin for Neovim. Mainly written in Lua.

Features

• Increment/decrement various number and other things
  • decimal/hex/octal/binary natural integers
  • decimal integers (including negative number)
  • date
  • alphabet
  • hex colors
  • markdown header

Similar plugins

• tpope/vim-speeddating

Installation

If you use vim-plug:

Plug 'monaqa/dial.nvim'

Usage

This plugin does not provide any default key-mapping. To use this plugin, assign the plugin key-mapping to the key you like, as shown below:

nmap <C-a> <Plug>(dial-increment)
nmap <C-x> <Plug>(dial-decrement)
vmap <C-a> <Plug>(dial-increment)
vmap <C-x> <Plug>(dial-decrement)
vmap g<C-a> <Plug>(dial-increment-additional)
vmap g<C-x> <Plug>(dial-decrement-additional)

Configuration

In this plugin, the target to increment/decrement is called augend. In dial.nvim, you can operate on multiple types of augend.

To specify the list of augend you want to operate on, write the following code in your .vimrc:

lua << EOF
local dial = require("dial")

dial.config.searchlist.normal = {
    "number#decimal",
    "number#hex",
    "number#binary",
    "date#[%Y/%m/%d]",
    "markup#markdown#header",
}
EOF

dial.searchlist.normal is the list of available augends in normal mode, and dial.augends is a submodule that stores augend, which is provided by default.

The default set of available augends are shown here:

If you just want to add a few of augends into default searchlist, you can also write the configuration like this:

lua << EOF
local dial = require("dial")

table.insert(dial.config.searchlist.normal, "markup#markdown#header")
EOF

Changing dial.serchlist.visual table, you can also customize the behavior of <C-a> / <C-x> in visual mode.

The list of currently enabled augends can be checked with :DialShowSearchList command.

User extension

You can even define your own augend. Augend is a table that contains two fields (name and desc) and two methods (find and add). For example, the following code defines my_augend, which enables you to double or halve the natural number.

lua << EOF
local dial = require("dial")

local my_augend = {
    desc = "double or halve the number. (1 <-> 2 <-> 4 <-> 8 <-> ...)",

    find = dial.common.find_pattern("%d+"),
    add = function(cursor, text, addend)
        local n = tonumber(text)
        n = math.floor(n * (2 ^ addend))
        text = tostring(n)
        cursor = #text
        return cursor, text
    end
}

dial.augends["custom#my_augend"] = my_augend

dial.config.searchlist.normal = {
    "custom#my_augend"
}
EOF

If you want to toggle true / false with dial.nvim's command, try this:

dial.augends["custom#boolean"] = dial.common.enum_cyclic{
    name = "boolean",
    strlist = {"true", "false"},
}
table.insert(dial.config.searchlist.normal, "custom#boolean")

Changelog

See HISTORY.

TODO

• Write help file
• Command for visual-block mode