next-update/src/cli-options.js

Tests if module's dependencies can be updated to the newer version without breaking the tests

'use strict'

var optimist = require('optimist')
var pkg = require('../package.json')
var la = require('lazy-ass')
var is = require('check-more-types')
var _ = require('lodash')
var path = require('path')

var parentFolder = path.join(__dirname, '..')
var info = pkg.name + ' - ' + pkg.description + '\n' +
    '  version: ' + pkg.version + '\n' +
    '  folder: ' + parentFolder + '\n' +
    '  author: ' + JSON.stringify(pkg.author)

var program = optimist
.options('revert', {
  boolean: true,
  description: 'install original module versions listed in package.json',
  default: false
})
.options('available', {
  boolean: true,
  alias: 'a',
  description: 'only query available later versions, do not test them',
  default: false
})
.options('module', {
  string: true,
  alias: 'm',
  description: 'checks specific module(s), can include version name@version',
  default: null
})
.options('without', {
  string: true,
  alias: 'w',
  description: 'skip checking this module(s)',
  default: null
})
.option('latest', {
  boolean: true,
  alias: 'l',
  description: 'only check latest available update',
  default: true
})
.option('color', {
  boolean: true,
  alias: 'c',
  description: 'color terminal output (if available)',
  default: true
})
.option('version', {
  boolean: true,
  alias: 'v',
  description: 'show version and exit',
  default: false
})
.option('test', {
  string: true,
  alias: 't',
  description: 'custom test command to run instead of npm test'
})
.option('skip', {
  boolean: true,
  description: 'skip running tests first',
  default: false
})
.option('all', {
  boolean: true,
  default: false,
  description: 'install all modules at once before testing'
})
.option('keep', {
  boolean: true,
  default: true,
  alias: 'k',
  description: 'keep tested version if it is working'
})
.option('allow', {
  string: true,
  default: 'major',
  description: 'allow major / minor / patch updates'
})
.options('type', {
  string: true,
  default: 'all',
  description: 'check dependencies of type (all, prod, dev, peer)'
})
.options('tldr', {
  boolean: true,
  default: false,
  description: 'only print VERY important log messages'
})
.options('changed-log', {
  boolean: true,
  default: true,
  alias: 'L',
  description: 'print commit changes between working versions'
})
.options('registry', {
  string: true,
  default: false,
  description: 'use a custom registry url'
})
.options('check-version-timeout', {
  number: true,
  default: 10000,
  description: 'define a custom timeout value for checking next versions'
})
.usage(info)
.argv

if (program.version) {
  console.log(info)
  process.exit(0)
}

if (program.help || program.h || program['?']) {
  optimist.showHelp()
  process.exit(0)
}

program.allowWasSpecified = _.includes(process.argv, '--allow')

if (is.string(program.module)) {
  program.module = program.module.split(',').map(_.trim)
  la(is.array(program.module), 'expected list of modules', program.module)
}

if (is.string(program.without)) {
  program.without = program.without.split(',').map(_.trim)
  la(is.array(program.without),
    'expected list of modules to skip in --without', program.without)
}

module.exports = program