Data.Text.AlignEqual

A module providing functions for text alignment and padding.

Documentation

prefixLength

Arguments

:: Text

The input text line

-> Int

The number of characters before the first '=' sign

Calculates the number of characters preceding the first '=' sign in a text line.

>>> prefixLength "key=value"
3
>>> prefixLength "a=b"
1
>>> prefixLength "noequals"
8

adjustLine

Arguments

:: Int

The desired prefix length

-> Text

The text line to pad

-> Text

The padded text line

Adjusts the prefix of a text line to a desired length by adding padding.

>>> adjustLine 5 "key=value"
"key  =value"
>>> adjustLine 3 "a=b"
"a  =b"

adjustText

Arguments

:: Text

The input text (possibly multi-line)

-> Text

The aligned text

Processes multi-line text to align all '=' signs across lines. Adjusts the prefix length of each line to match the maximum prefix length.

>>> adjustText "key=value\na=b"
"key=value\na  =b"
>>> adjustText "x=y\nlong=var"
"x   =y\nlong=var"