windwp/nvim-autopairs
Nvim Autopairs
nvim-autopairs is a Lua-based extension for Neovim that automatically inserts closing brackets, quotes, and keywords to maintain balanced syntax. It functions as a contextual bracket automator, utilizing Tree-Sitter structural nodes to determine when to insert or skip closing characters based on the code's actual syntax tree.
The plugin distinguishes itself by using Tree-Sitter awareness to prevent inserting pairs inside strings or comments. It supports dynamic closing string resolution and custom pairing logic, allowing users to define specific rules using regular expressions and filetype filters.
Beyond basic insertion, the tool manages synchronized pair deletion, text wrapping for selected blocks, and newline block formatting. It also integrates with completion engines to automate the insertion of closing characters after selecting a function or method.
Features
- Neovim Plugins - Provides an automated pairing and balancing system as a plugin for the Neovim editor.
- Automatic Character Pairing - Automatically inserts matching closing characters during text entry by listening for specific key presses.
- Auto-closing Brackets - Automatically inserts closing brackets, quotes, and keywords in Neovim to maintain balanced syntax.
- Automatic Brace and Quote Insertions - Automatically inserts the matching closing brace, bracket, or quote when the opening character is typed.
- Custom Auto-Pair Definitions - Allows users to define pairing logic for specific characters and restrict their activation to designated filetypes.
- Simultaneous Pair Deletion - Automatically removes the closing part of a pair when the corresponding opening part is deleted.
- Synchronized Pair Deletion - Automatically removes the closing part of a pair when the corresponding opening part is deleted.
- Pattern-Based Triggers - Defines specific keys or text patterns that must be matched to trigger the insertion of a closing pair.
- AST-Driven Pair Management - Uses Tree-Sitter structural nodes to determine when to insert or skip closing characters.
- Filetype-Aware Syntax Support - Manages closing tags, brackets, and keywords automatically based on the current language filetype and syntax tree.
- Contextual Pair Automation - Manages balanced pairs using rules based on filetypes, regular expressions, and cursor position.
- Structural Node Filtering - Uses structural node data to prevent inserting pairs inside strings or comments.
- Structural Node Validation - Analyzes the current syntax tree to prevent inserting pairs inside strings, comments, or invalid structural nodes.
- Filetype Mappings - Associates pairing logic and behavioral constraints with specific language identifiers to ensure correct syntax across files.
- Pair Insertion Predicates - Evaluates line content and structural nodes to determine the appropriate moment for inserting closing characters.
- Regex Pattern Matching - Uses regex rules to verify surrounding text before triggering an automatic pairing action.
- Automated Closing Sequences - Inserts multiple closing brackets simultaneously or generates dynamic closing text based on the opening pattern.
- Closing Character Cursor Management - Moves the cursor past an existing closing character instead of inserting a duplicate when the ending part is already present.
- Closing Keyword Insertion - Adds a closing keyword at the end of a block based on the opening statement and language rules.
- Dynamic Ending Generation - Calculates the closing string at runtime using custom functions to allow for variable closing characters.
- Conditional Pair Completion - Prevents the product from inserting closing characters unless specific text patterns or structural nodes are detected near the cursor.
- Auto-Indented Pair Lines - Provides automatic insertion of indented lines between matching pairs when the enter key is pressed.
- Engine Integrations - Integrates with completion engines to automatically insert closing parentheses and brackets after selecting functions or methods.
- Pair-Aware Line Breaks - Automatically moves closing characters to a new line below the cursor when pressing enter between a pair.
- Delimiter Wrapping - Surrounds existing blocks of text or selections with brackets and quotes using fast wrap sequences.
- Fast-Wrap Sequences - Surrounds selected text with brackets or quotes using a dedicated fast-wrap sequence.
- Statement Closure Automation - Inserts closing statements for language constructs like if/then/end specifically after a newline is pressed.
- Code Block Wrapping - Handles line breaks and indentation within paired brackets to keep code structured.
- Conditional Pairing Insertion - Restricts the product's automatic closing character insertion based on surrounding text, regular expressions, or specific node types.
- Context Aware Pairing - Prevents the product from inserting a closing pair if one already exists on the line or follows alphanumeric characters.
- Cursor Position Mapping - Determines whether to jump past or overlap with existing closing characters based on the current cursor index.
- Dynamic Closing Resolution - Calculates the required closing character or keyword at runtime using custom functions for complex language constructs.
- Editing and Text Manipulation - Minimalist autopairing for brackets and quotes.
