How to install boole.nvim in Neovim?

Install via Git clone into Neovim's site directory, as shown in the installation section. For package managers, use the repository URL, though the README focuses on manual installation for simplicity.

Can I add my own word lists to boole.nvim?

Yes, you can add custom word cycles by defining them in the additions or allow_caps_additions arrays in the setup function. This allows for personalized sequences like project-specific terms or common patterns.

Boole.nvim vs vim-speeddating: which is better for incrementing dates?

Boole.nvim handles general word and boolean cycling, including days and months, while vim-speeddating is specialized for date and time increments with more date-specific features. Choose boole.nvim for broader word toggling, and vim-speeddating for precise date manipulation.

How do I map boole.nvim to different keys in Neovim?

Map it by setting the increment and decrement keys in the mappings table of the setup function, such as using ' ' and ' ' or custom bindings. Refer to the configuration example in the README for specific syntax.

Does boole.nvim affect the performance of Neovim?

Boole.nvim is designed to be lightweight and should have minimal performance impact, as it extends existing functionality without heavy processing. However, extensive custom cycles might add slight overhead depending on usage.

Is boole.nvim compatible with regular Vim?

No, boole.nvim is built specifically for Neovim and relies on its Lua API, so it is not compatible with regular Vim. Users must be on Neovim to utilize this plugin.

How to toggle boolean values using boole.nvim?

Position the cursor on a word like true or false and use the mapped increment/decrement keys, which will cycle through predefined boolean pairs. The plugin seamlessly integrates with Neovim's default bindings for this purpose.

Open-Awesome

boole.nvim

0BSDLuav3.0.1

Neovim plugin that extends increment/decrement keys to toggle booleans and cycle through words like days, months, and colors.

GitHub

189 stars8 forks0 contributors

What is boole.nvim?

Boole.nvim is a Neovim plugin that extends the default increment and decrement functionality of Ctrl-A and Ctrl-X to toggle boolean values and cycle through word sequences. It solves the problem of manually editing repetitive text patterns like days, months, colors, and booleans by providing keyboard-driven navigation.

Target Audience

Neovim users who frequently edit text with repetitive patterns, such as developers writing configuration files, documentation, or any content involving boolean values, dates, or color names.

Value Proposition

Developers choose Boole.nvim for its seamless integration with existing Neovim keybindings, lightweight design, and customizable word cycles, eliminating the need for manual text replacement or external tools.

Overview

Neovim plugin for toggling booleans, etc.

Use Cases

Best For

Toggling boolean values in configuration files
Cycling through days and months in documentation
Navigating color names in CSS or design files
Editing repetitive word sequences in text
Enhancing Neovim's native increment/decrement keys
Creating custom word cycles for project-specific terms

Not Ideal For

Projects requiring advanced text manipulation with regular expressions or complex pattern matching
Users who need extensive, out-of-the-box word lists for multiple languages or specialized domains without customization
Teams that prefer mouse-driven or GUI-based editing workflows over keyboard shortcuts

Pros & Cons

Pros

Boolean Toggling Efficiency

Directly toggles between common boolean pairs like true/false and on/off, streamlining edits in configuration files and code without manual replacement.

Customizable Word Cycles

Allows users to define their own word sequences in the setup function, enabling project-specific cycles such as tic/tac/toe, as shown in the configuration example.

Lightweight Integration

Extends Neovim's native Ctrl-A and Ctrl-X keybindings without adding significant overhead, adhering to the minimalist philosophy described in the README.

Case Preservation Support

Supports case-sensitive cycling for user-defined additions, ensuring that cycles like enable/disable maintain proper casing, enhancing usability in varied contexts.

Cons

Limited Default Sequences

Only includes predefined sets like days, months, and colors, which may not cover all use cases without manual configuration, as admitted by the plugin's reliance on user additions.

Configuration Overhead

Requires Lua setup for mappings and custom additions, which can be a barrier for users not familiar with Neovim's Lua API, adding complexity to initial setup.

Neovim-Exclusive

Works exclusively in Neovim due to its Lua-based implementation, making it unsuitable for Vim users or those in mixed editor environments, limiting its adoption scope.

Frequently Asked Questions

Related Projects

nvim-autopairs

autopairs for neovim written in lua

Stars4,066

Forks141

Last commit2 months ago

nvim-treesitter-context

Show code context

Stars3,215

Forks236

Last commit2 months ago

zen-mode.nvim

🧘 Distraction-free coding for Neovim

Stars2,149

Forks76

Last commit8 months ago

nvim-ts-autotag

Use treesitter to auto close and auto rename html tag

Stars2,104

Forks109

Last commit3 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub