fixpack/fixpack.js

cli tool that cleans up package.json files.

#!/usr/bin/env node

'use strict'

const ALCE = require('alce')
const fs = require('fs')
const path = require('path')
const chalk = require('chalk')
const detectIndent = require('detect-indent')
const detectNewline = require('detect-newline')

const defaultConfig = require('./config')

const CRLF = '\r\n'
const LF = '\n'

function checkMissing (pack, config) {
  let warnItems
  let required
  if (pack.private) {
    warnItems = config.warnOnPrivate
    required = config.requiredOnPrivate
  } else {
    warnItems = config.warn
    required = config.required
  }
  required.forEach(function (key) {
    if (pack[key] == null) { throw new Error(config.fileName + ' files must have a ' + key) }
  })
  warnItems.forEach(function (key) {
    if (pack[key] == null && !config.quiet) console.log(chalk.yellow('missing ' + key))
  })
}

function sortAlphabetically (object) {
  if (Array.isArray(object)) {
    object.sort()
    return object
  } else {
    const sorted = {}
    Object.keys(object)
      .sort()
      .forEach(function (key) {
        sorted[key] = object[key]
      })
    return sorted
  }
}

module.exports = function (file, config) {
  config = Object.assign(defaultConfig, config || {})
  if (!fs.existsSync(file)) {
    if (!config.quiet) console.log(chalk.red('No such file: ' + file))
    return 1
  }
  config.fileName = path.basename(file)
  const original = fs.readFileSync(file, { encoding: 'utf8' })
  const indent = config.indent != null
    ? config.indent
    : detectIndent(original).indent
  const newLine = config.newLine != null
    ? (
      config.newLine === 'CRLF'
        ? CRLF
        : LF
    ) : detectNewline(original)
  const finalNewLine = config.finalNewLine != null
    ? !!config.finalNewLine
    : /\n$/.test(original)
  const out = {}
  let pack = ALCE.parse(original)
  let outputString = ''
  let key

  // make sure we have everything
  checkMissing(pack, config)

  // handle the specific ones we want, then remove
  config.sortToTop.forEach(function (key) {
    if (pack[key] != null) out[key] = pack[key]
    delete pack[key]
  })

  // sort the remaining
  pack = sortAlphabetically(pack)

  // add in the sorted ones
  for (key in pack) {
    out[key] = pack[key]
  }

  // sometimes people use a string rather than an array for the `keywords`
  // field when there is only one item listed
  if (typeof out.keywords === 'string') out.keywords = [out.keywords]

  // sort some sub items alphabetically
  config.sortedSubItems.forEach(function (key) {
    if (out[key] != null) out[key] = sortAlphabetically(out[key])
  })

  // wipe version numbers
  if (config.wipe) {
    const versionedKeys = [
      'dependencies',
      'devDependencies',
      'peerDependencies',
      'optionalDependencies'
    ]
    versionedKeys.forEach(function (key) {
      const depGroup = out[key]
      if (depGroup) {
        for (var item in depGroup) {
          depGroup[item] = '*'
        }
      }
    })
  }

  // write it out
  outputString = JSON.stringify(out, null, indent)

  if (newLine === CRLF) {
    outputString = outputString.replace(/\n/g, CRLF) + (finalNewLine ? CRLF : '')
  } else {
    outputString = outputString + (finalNewLine ? LF : '')
  }

  if (outputString === original) {
    config.quiet || console.log(chalk.bold(config.fileName) + chalk.green(' already clean') + '!')
    return 0
  }

  if (config.dryRun) {
    config.quiet || console.log(chalk.bold(config.fileName) + chalk.red(' not fixed') + '!')
  } else {
    fs.writeFileSync(file, outputString, { encoding: 'utf8' })
    config.quiet || console.log(chalk.bold(config.fileName) + chalk.green(' fixed') + '!')
  }
  return 1
}