junegunn/vim-easy-align
Vim Easy Align
vim-easy-align is a text alignment plugin and extension for the Vim editor. It functions as a regular expression-based text formatter designed to vertically align text across multiple lines.
The tool identifies alignment anchor points using characters or regular expressions to create tabular layouts and organized source code formatting. It supports specific occurrence targeting to determine which instance of a repeating character serves as the anchor, as well as the ability to define custom alignment rules and delimiters.
Capabilities include multi-line text alignment with left, right, or center modes, and the ability to restrict alignment operations to rectangular blocks of text. The system incorporates syntax-aware filtering to ignore delimiters found within strings or comments and provides a real-time visual preview of the alignment result before it is applied.
Features
- Interactive Text Alignment - Provides an interactive workflow for aligning text columns and markers within the Vim editor.
- Source Code Formatters - Restructures source code layout by lining up variable assignments and configuration blocks for better readability.
- Pattern-Based Alignments - Enables the use of arbitrary regular expressions as delimiters for precise vertical text alignment.
- Regular Expression Pattern Identification - Uses regular expressions to identify the character sequences that serve as alignment anchor points.
- Layout-Based Text Transformations - Restructures text layouts by using regular expressions to identify and align delimiters vertically.
- Text Alignment Utilities - Positions text across multiple lines using specified characters with left, right, or center alignment modes.
- Vim Plugins - Extends the Vim editor with specialized horizontal text adjustment and alignment capabilities.
- White-Space Based Text Transformations - Modifies selected ranges of lines by inserting spaces to shift text without altering the actual content.
- Horizontal Offset Calculations - Computes the maximum horizontal offset across a selection to determine the final alignment position for all characters.
- Delimiter-Based Character Alignment - Adjusts the horizontal position of text based on a selected character to ensure vertical consistency.
- Syntax-Aware Filters - Implements syntax-aware filtering to ignore alignment anchors located inside strings or comments.
- Alignment Delimiter Definitions - Allows the definition of specific characters or patterns via regex to handle unique project syntax during alignment.
- Line-Based Text Filters - Aligns only the lines that match a specific pattern while ignoring other lines in the selection.
- Plain Text Tabular Formatting - Creates table-like layouts in plain text files by aligning specific characters or regular expressions.
- Text Alignment Previews - Provides a real-time visual preview of the projected alignment result as the user selects delimiters.
- String-Aware Comment Filtering - Provides parsing logic that prevents alignment delimiters inside string literals or comments from being targeted.
- Rectangular Block Operations - Allows alignment operations to be restricted to a specific rectangular block of text.
- Syntax-Aware Filtering - Provides a logical filter that skips delimiters found within strings or comments to preserve code structure.
- Multi-Column Text Alignment - Targets multiple or alternating instances of a delimiter to create complex, multi-column tabular layouts.
- Occurrence Targeting - Allows users to target a specific instance of a repeating character on a line to serve as the alignment anchor.
