yaml-sort/yaml-sort.js

Sort YAML files alphabetically

#!/usr/bin/env node

'use strict'

const fs = require('fs')
const yaml = require('js-yaml')
const yargs = require('yargs')
const { hideBin } = require('yargs/helpers')

const argv = yargs(hideBin(process.argv))
  .usage('Usage: $0 [options]')
  .example([
    ['$0 --input config.yml',
      'Sorts alphabetically and overwrites the file config.yml'],
    ['$0 --input config.yml --lineWidth 100 --stdout',
      'Sorts the file config.yml and output result to STDOUT wrapped to 100 columns'],
    ['$0 --input config.yml --indent 4 --output sorted.yml',
      'Indents with 4 spaces and outputs result to file sorted.yml'],
    ['cat config.yml | $0',
      'Sorts alphabetically from STDIN']
  ])
  .option('input', {
    alias: 'i',
    describe: 'The YAML file(s) which needs to be sorted',
    default: '-',
    defaultDescription: 'STDIN',
    normalize: true,
    string: true,
    array: true
  })
  .option('output', {
    alias: 'o',
    describe: 'The YAML file to output sorted content to',
    defaultDescription: 'overwrite input file if specified or STDOUT',
    normalize: true,
    string: true
  })
  .option('stdout', {
    alias: 's',
    describe: 'Output the proposed sort to STDOUT only',
    conflicts: 'output',
    boolean: true
  })
  .option('check', {
    alias: 'k',
    describe: 'Check if the given file(s) is already sorted',
    conflicts: ['output', 'stdout'],
    boolean: true
  })
  .option('indent', {
    alias: 'id',
    default: 2,
    describe: 'Indentation width (in spaces)',
    number: true
  })
  .option('encoding', {
    alias: 'e',
    default: 'utf8',
    describe: 'Input encoding',
    choices: ['ascii', 'utf8', 'utf16le']
  })
  .option('quotingStyle', {
    alias: 'q',
    default: 'single',
    describe: 'Strings will be quoted using this quoting style',
    choices: ['single', 'double']
  })
  .option('forceQuotes', {
    alias: 'f',
    describe: 'Force quotes around all strings',
    boolean: true
  })
  .option('lineWidth', {
    alias: 'w',
    default: 80,
    describe: 'Wrap line width (-1 for unlimited width)',
    number: true
  })
  .help('h')
  .alias('h', 'help')
  .version()
  .wrap(null)
  .parse()

let success = true

argv.input.forEach((file) => {
  try {
    const isStdin = file === '-'

    if (isStdin && process.stdin.isTTY) {
      console.error('Missing filename or input ("yaml-sort --help" for help)')
      process.exit(22)
    }

    const output =
      argv.stdout || (argv.output === '.') || (isStdin && !argv.output)
        ? process.stdout.fd
        : (argv.output ? argv.output : file)

    const content = fs.readFileSync(isStdin ? process.stdin.fd : file, argv.encoding)

    const documents = yaml.loadAll(content)

    const sortedDocuments = documents.map(doc => yaml.dump(doc, {
      sortKeys: true,
      indent: argv.indent,
      lineWidth: argv.lineWidth,
      quotingType: argv.quotingStyle === 'double' ? '"' : "'",
      forceQuotes: argv.forceQuotes
    }))

    const hasDocumentStart = content.toString().trimStart().startsWith('---')

    const sortedContent = (hasDocumentStart ? '---\n' : '') + sortedDocuments.join('---\n')

    if (argv.check) {
      if (sortedContent !== content.toString()) {
        success = false
        console.warn(`'${file}' is not sorted and/or formatted (indent, line width).`)
      }
    } else {
      fs.writeFile(
        output,
        sortedContent,
        (error) => {
          if (error) {
            success = false
            console.error(error)
          }
        })
    }
  } catch (error) {
    success = false
    console.error(error)
  }
})

if (!success) {
  process.exit(1)
}