align-equal 0.1.1.0 → 0.1.1.1

raw patch · 3 files changed

+63/−2 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +8/−0
• README.md +54/−1
• align-equal.cabal +1/−1

@@ -1,6 +1,14 @@ # Changelog All notable changes to the `align-equal` project will be documented in this file. +## [0.1.1.1] - 2025-03-31+### Added  +- Expanded `README.md` with a detailed description of the tool.  +- Included Vim usage instructions with examples.  ++### Miscellaneous  +- Bumped version to `0.1.1.1` in `align-equal.cabal`.  + ## [0.1.1.0] - 2025-03-27 - **Added**: Extracted core functions into a separate library module (`Data.Text.AlignEqual`).   - Refactored original `Main.hs` into executable and library components.

@@ -1,2 +1,55 @@-This project is based on an idea from Gabriella Gonzalez.+# align-equal++This project is based on an idea from Gabriella Gonzalez.   For more details, visit: [Gabriella's blog](https://www.haskellforall.com/2018/10/detailed-walkthrough-for-beginner.html)++`align-equal` is a command-line tool that aligns text based on the `=` symbol.  +It ensures that all `=` signs are vertically aligned, improving readability.++This program reads text from **standard input**, processes it, and outputs the aligned result to **standard output**.++## Installation++To install `align-equal` using `cabal`, run:++```sh+cabal install align-equal+```++## Usage++### **Using in Vim**++`align-equal` is primarily designed for use within Vim. You can align selected text in **visual mode** as follows:++1. Select the lines you want to align in **visual mode** (`V` for line-wise selection).+2. Run:  +   ```vim+   :!align-equal+   ```+3. The selected text will be replaced with an aligned version.++#### **Example**++**Before (Selected Text in Visual Mode)**:+```vim+x = 1+longVariable = 2+short = 3+```++**Command**:+```vim+:!align-equal+```++**After**:+```vim+x            = 1+longVariable = 2+short        = 3+```++## How it Works++`align-equal` scans the input, detects `=` symbols, and aligns them by adding the appropriate amount of whitespace.

@@ -1,6 +1,6 @@ cabal-version: 3.0 name: align-equal-version: 0.1.1.0+version: 0.1.1.1 license: MIT license-file: LICENSE author: Joonkyu Park (based on original work by Gabriella Gonzalez)