About

Fork of https://github.com/ddebin/yaml-sort with added nested arrays sorting capabilities.

yaml-sort is a CLI tool sorting alphabetically YAML files.

This tool is basically a tiny wrapper around js-yaml.

(Inspired by yml-sorter)

Installation

npm install -g yaml-sort-with-arrays

Usage

Usage: yaml-sort [options]

Options:
  --input, -i      The YAML file(s) which needs to be sorted  [array] [required]
  --output, -o     The YAML file to output sorted content to  [string]
  --stdout, -s     Output the proposed sort to STDOUT only  [boolean] [default: false]
  --check, -k      Check if the given file(s) is already sorted  [boolean] [default: false]
  --indent, --id   Indentation width to use (in spaces)  [number] [default: 2]
  --lineWidth, -w  Wrap line width  [number] [default: 80]
  -h, --help       Show help  [boolean]
  --version        Show version number  [boolean]

Examples:
  yaml-sort --input config.yml                                 Sorts alphabetically and overwrites the file config.yml.
  yaml-sort --input config.yml --lineWidth 100 --stdout        Sorts the file config.yml and output result to STDOUT wrapped to 100 columns
  yaml-sort --input config.yml --indent 4 --output sorted.yml  Indents with 4 spaces and outputs result to file sorted.yml.