kylechui/nvim-surround
Nvim Surround
nvim-surround is a Lua-based extension for Neovim designed to add, change, and delete surrounding delimiter pairs around text and code. It functions as a text object manipulator that wraps or removes brackets, quotes, and tags using motions and selections.
The plugin integrates with Tree-sitter to identify structural code nodes, allowing for the precise surrounding of syntax elements based on the structural syntax tree. It also supports custom surround definitions, enabling users to define specialized delimiter pairs and aliases.
The core capability surface covers basic surrounding operations, including adding, changing, and deleting delimiters. It includes support for repeating the most recent surround action to maintain formatting consistency across different text selections.
Features
- Neovim Plugins - Provides an extension for adding, changing, or removing pairs of brackets and tags within Neovim.
- Structural Node Querying - Uses Tree-sitter structural node querying to precisely identify and surround complex code blocks.
- Lua-Based Text Buffer Manipulations - Implements text transformations by calling Lua functions that interface with the Neovim API for buffer editing.
- Motion-Based Selection - Calculates the target text area by executing Neovim motions before applying surrounding delimiters.
- Structural Code Wrapping - Wraps code elements in delimiters or changes existing syntax markers to update the structure of a document.
- Surrounding Character Management - Replaces an existing pair of surrounding characters with a different pair to update text formatting.
- Text Object Selection - Modifies text by wrapping or removing brackets, quotes, and tags using structural text object selection.
- Surrounding Text Wrappers - Wraps text, tags, or function calls in balanced pairs of characters based on specified motions.
- Delimiter-Based Text Modifications - Identifies surrounding characters by comparing text against registered pairs and closing symbols.
- Surround Management - Adds, changes, and deletes surrounding delimiter pairs around text and code in Neovim.
- Tree-Sitter Parsers - Determines text boundaries by querying the structural syntax tree using Tree-sitter.
- Syntax Tree Node Retrieval - Uses Tree-sitter to identify and retrieve structural syntax tree nodes to determine precise text boundaries for surrounding operations.
- Repeatable Surround Operations - Applies the most recent surrounding operation to a new selection of text to maintain formatting consistency.
- Custom Surroundings - Allows users to define specialized delimiter pairs and aliases based on custom patterns or syntax nodes.
- Action Repetition State Tracking - Stores the most recent surround action in a local variable to allow repetition via the dot operator.
- Configuration Registries - Maps user-defined aliases and patterns to specific delimiter pairs within a central Lua configuration table.
- Syntax Highlighting - Add, change, or delete surrounding delimiter pairs.
