Unibeautify-CLI

CLI for Unibeautify

Installation

$ npm install --global @unibeautify/cli

Usage

The package will be globally accessible as a new command-line interface (CLI) application called unibeautify.

Help

Note: Not all options are currently supported.

$ unibeautify --help

unibeautify

Beautify Files

Commands:
  unibeautify          Beautify Files                                  [default]
  unibeautify support  List languages and beautifiers        [aliases: list, ls]

Options:
  --version          Show version number                               [boolean]
  --help             Show help                                         [boolean]
  --config-file, -c  Beautifier configuration file                      [string]
  --config-json      Beautifier configuration as stringified JSON       [string]
  --file-path, -f    Path of the file to beautify from stdin            [string]
  --inplace, -i      Replace file(s) with beautified results [boolean] [default: false]  
  --language, -l     Language of file to beautify            [string] [required]
  --out-file, -o     Output file of beautified results                  [string]

$ unibeautify list --help

unibeautify support

List languages and beautifiers

Options:
  --version          Show version number                               [boolean]
  --help             Show help                                         [boolean]
  --all, -a          List all languages supported               [default: false]
  --beautifiers, -b  List installed beautifiers                 [default: false]
  --json, -j         List as JSON array                         [default: false]
  --languages, -l    List supported languages based on installed beautifiers [default: false]

Example

Install unibeautify and a Beautifier, such as beautifier-prettydiff:

$ npm install --global unibeautify @unibeautify/beautifier-prettydiff

Then beautify using a language that Beautifier supports:

$ unibeautify --language JavaScript --config-json '{"JavaScript": {"beautifiers": ["ESLint"],"quotes": "double"}}' <<< "const test = 'test';"

This returns the following formatted result:

const test = "test";