How do I set up buffer-local keymaps with nest.nvim?

Use the 'buffer' field in keymapConfigs: set it to 'true' for the current buffer or a specific buffer number, as shown in the Quickstart Guide with <C- keymaps. This allows cascading options to apply only to designated buffers.

Can nest.nvim handle conditional keymaps based on file type or mode?

While it supports Lua function bindings and expression mappings for dynamic behavior, conditional logic must be implemented manually in those functions. The tree structure itself is declarative and doesn't natively support runtime conditionals.

nest.nvim vs vim.keymap.set: which is better for Neovim keymaps?

nest.nvim excels for organizing complex, hierarchical keymap setups with cascading options, while vim.keymap.set is a built-in, imperative API better suited for simple, one-off mappings. Choose nest.nvim if modularity and readability are priorities.

How to modularize keymap configurations across different files using nest.nvim?

Define keymapConfigs as plain Lua tables in separate files and require them, then pass them to applyKeymaps under different prefixes or options. This leverages Lua's modularity, as mentioned in the README for reusability.

Does nest.nvim support leader key mappings?

Yes, leader keys are supported by including them in prefixes, such as ' ' in nested tables. The cascading structure makes it easy to group leader-based keymaps, as demonstrated in the Telescope and LSP examples.

nest.nvim — Neovim Keymap Tree Utility

Q: Can nest.nvim handle conditional keymaps based on file type or mode?

While it supports Lua function bindings and expression mappings for dynamic behavior, conditional logic must be implemented manually in those functions. The tree structure itself is declarative and doesn't natively support runtime conditionals.

Q: nest.nvim vs vim.keymap.set: which is better for Neovim keymaps?

nest.nvim excels for organizing complex, hierarchical keymap setups with cascading options, while vim.keymap.set is a built-in, imperative API better suited for simple, one-off mappings. Choose nest.nvim if modularity and readability are priorities.

Q: How to modularize keymap configurations across different files using nest.nvim?

Define keymapConfigs as plain Lua tables in separate files and require them, then pass them to applyKeymaps under different prefixes or options. This leverages Lua's modularity, as mentioned in the README for reusability.

Q: Does nest.nvim support leader key mappings?

Yes, leader keys are supported by including them in prefixes, such as ' ' in nested tables. The cascading structure makes it easy to group leader-based keymaps, as demonstrated in the Telescope and LSP examples.

What is nest.nvim?

nest.nvim is a Neovim plugin that provides a Lua-based utility for defining keymaps using cascading trees. It solves the problem of managing complex keybinding configurations by allowing developers to structure mappings in nested, readable lists where prefixes and options inherit from parent nodes. This approach makes it easier to organize, refactor, and maintain keymaps in Neovim.

Target Audience

Neovim users and plugin developers who want a more maintainable and modular way to define keybindings, especially those managing extensive custom configurations or building plugins with complex keymapping needs.

Value Proposition

Developers choose nest.nvim for its concise, tree-based syntax that mirrors mental models of keymap organization, its support for binding Lua functions directly to keys, and its minimal codebase that integrates seamlessly into Lua-centric Neovim setups without bloat.

Overview

nest.nvim is a Neovim plugin that provides a pure Lua utility for defining keymaps in a modular, readable, and maintainable way. It allows developers to structure keybindings as nested trees, where prefixes and configuration options cascade down to child mappings, making complex keymap setups easier to organize and refactor.

Key Features

Cascading Tree Structure — Define keymaps in nested lists where prefixes and options inherit from parent nodes, improving readability and grouping.
Lua Function Bindings — Map keys directly to Lua functions, with support for expression mappings (expr) for dynamic behavior.
Flexible Configuration — Set modes, buffer-specific mappings, and options (like silent, noremap) that cascade through the tree.
Minimal Codebase — Written in a single ~100-line Lua file, focusing on simplicity and ease of integration.
Modular Design — Keymap configurations are plain Lua tables that can be defined in separate files, passed around, or reused under different prefixes.

Philosophy

nest.nvim emphasizes a declarative, tree-based approach to keymapping that aligns with how developers mentally organize shortcuts, promoting maintainability and clarity in Neovim configuration.

nest.nvim

What is nest.nvim?

Overview

Key Features

Philosophy

Related Projects

Found a gem we're missing?

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions