Skip to content

Latest commit

 

History

History
54 lines (44 loc) · 1.43 KB

README.md

File metadata and controls

54 lines (44 loc) · 1.43 KB
Raw

boole.nvim 🔛

Boole is a simple Neovim plugin that extends the default increment and decrement functionality of CTRL-A and CTRL-X to allow for toggling boolean values like on, yes, and true as well as cycling through:

  • Days of the week and their abbreviations (e.g., Monday → Tuesday)
  • Months of the year and their abbreviations (e.g., Jan → Feb)
  • X11 / Web color names (e.g., Orange → OrangeRed)
  • Canonical hours (e.g., Compline → Vigil)
  • Letter + number "words" (e.g., F1 → F2)

This plugin ships one command:

  • :Boole {increment|decrement}

This command can be safely mapped to CTRL-A and CTRL-X. See the configuration section below for an example.

Installation

$ git clone --depth 1 https://github.com/nat-418/boole.nvim ~/.local/share/nvim/site/pack/boole/start/boole.nvim

Configuration

Boole can be mapped to a key by passing a configuration table to the setup function. You can also add any cycle of words you would like. Feel free to submit an issue and pull request with additions you think would make good defaults.

require('boole').setup({
  mappings = {
    increment = '<C-a>',
    decrement = '<C-x>'
  },
  -- User defined loops
  additions = {
    {'Foo', 'Bar'},
    {'tic', 'tac', 'toe'}
  },
  allow_caps_additions = {
    {'enable', 'disable'}
    -- enable → disable
    -- Enable → Disable
    -- ENABLE → DISABLE
  }
})