https://github.com/khalilouali/align-rs

A command-line utility which aligns a block of text within the terminal (or a specified number of columns), written in Rust.
https://github.com/khalilouali/align-rs

alignment cli output-formatting rust-lang text-tools

Last synced: about 1 year ago
JSON representation

A command-line utility which aligns a block of text within the terminal (or a specified number of columns), written in Rust.

• Host: GitHub
• URL: https://github.com/khalilouali/align-rs
• Owner: KhalilOuali
• License: apache-2.0
• Created: 2023-07-18T04:22:10.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-18T14:40:20.000Z (almost 3 years ago)
• Last Synced: 2024-11-08T15:17:47.562Z (over 1 year ago)
• Topics: alignment, cli, output-formatting, rust-lang, text-tools
• Language: Rust
• Homepage:
• Size: 426 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

          
# align: a command line utility for aligning text.

[![Crates.io](https://img.shields.io/crates/v/align_text)](https://crates.io/crates/align_text)

## ⭐ Overview

Aligns text within the terminal (or a specified number of columns).  

The text is treated as a block, and you can align the content within it, or align it within the space.

## 💻 Examples:

![Screenshot](Examples.png)

## ⌨ Usage

Text is read from stdin (terminal input, pipe in, etc.), formatted according to the options, then written out.

```

Usage: align [OPTIONS]

Options:

  -o, --outer       Where to align the block of text [default: left] [possible values: left, center, right]

  -i, --inner       Where to align text inside the block [default: left] [possible values: left, center, right]

  -a, --align       Shorthand for specifiying both [possible values: left, center, right]

  -c, --columns   Number of columns. Takes text's width if 0, terminal's width if unspecified

  -w, --wrap               Wrap the lines of text to fit in the number of columns

  -t, --trim               Trim the spaces around the lines before aligning

  -k, --keep               Keep the spaces on the right in output

  -b, --bias         Offset if line can't be centered perfectly [default: left] [possible values: left, right]

  -h, --help               Print help (see more with '--help')

  -V, --version            Print version

```

* Tip: You can use the command twice to format a block with a specific width, then align it in a bigger space.

### Error: "couldn't get terminal width"

This program uses the [term_size](https://crates.io/crates/term_size) crate to determine the terminal width by inspecting `stdout`, `stdin`, or `stderr`. If none of these streams is a tty (connected to the terminal), the terminal width can't be calculated.

This can happen if you're redirecting all three streams. Example: `echo "test" | align > test.txt 2>&1`, which produces `Error: "couldn't get terminal width"`.

In such a case, you must specify the number of columns yourself, see [Usage](#usage).

## 🙏 Special Thanks

* [clap](https://github.com/clap-rs/clap): Command Line Argument Parser for Rust.

* [term_size](https://github.com/clap-rs/term_size-rs): A Rust library to enable getting terminal sizes and dimensions.

* FOSS and Rust communities 💖.