ExAlign.CLI (exalign v0.1.3)

Copy Markdown

Command-line interface for ExAlign.

Usage

exalign [options] <file|dir> [<file|dir> ...]

Options

--line-length N       Maximum line length (default: 98)
--wrap-short-lines    Re-wrap lines that are shorter than line-length
--wrap-with backslash|do  How to wrap `do` expressions (default: backslash)
--check               Check formatting without writing files; exit 1 if any
                      file would be changed
--dry-run             Print would-be changes without writing files
-s, --silent          Suppress all stdout output
-h, --help            Print this help

Global configuration

Default values for --line-length, --wrap-short-lines, and --wrap-with can be set in ~/.config/exalign/.formatter.exs. CLI flags always take precedence over that file. See ExAlign module docs for the file format.

Examples

exalign lib/
exalign --line-length 120 lib/ test/
exalign --check lib/

Summary

Functions

Parses argv and runs the formatter. Returns :ok on success or {:error, exit_code} on failure. Does not call System.halt/1, making it safe to call from tests.

Functions

main(argv)

run(argv)

Parses argv and runs the formatter. Returns :ok on success or {:error, exit_code} on failure. Does not call System.halt/1, making it safe to call from tests.