/* * Copyright 2016 resin.io * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ 'use strict' const _ = require('lodash') const fs = require('fs') const yargs = require('yargs') const utils = require('./utils') const robot = require('../shared/robot') const EXIT_CODES = require('../shared/exit-codes') const errors = require('../shared/errors') const packageJSON = require('../../package.json') /** * @summary The minimum required number of CLI arguments * @constant * @private * @type {Number} */ const MINIMUM_NUMBER_OF_ARGUMENTS = 1 /** * @summary The index of the image argument * @constant * @private * @type {Number} */ const IMAGE_PATH_ARGV_INDEX = 0 /** * @summary The first index that represents an actual option argument * @constant * @private * @type {Number} * * @description * The first arguments are usually the program executable itself, etc. */ const OPTIONS_INDEX_START = 2 /** * @summary Parsed CLI options and arguments * @type {Object} * @public */ module.exports = yargs // Don't wrap at all .wrap(null) .demand(MINIMUM_NUMBER_OF_ARGUMENTS, 'Missing image') // Usage help .usage('Usage: $0 [options] ') .epilogue([ 'Exit codes:', _.map(EXIT_CODES, (value, key) => { const reason = _.map(_.split(key, '_'), _.capitalize).join(' ') return ` ${value} - ${reason}` }).join('\n'), '', 'If you need help, don\'t hesitate in contacting us at:', '', ' GitHub: https://github.com/resin-io/etcher/issues/new', ' Gitter: https://gitter.im/resin-io/etcher' ].join('\n')) // Examples .example('$0 raspberry-pi.img') .example('$0 --no-check raspberry-pi.img') .example('$0 -d /dev/disk2 ubuntu.iso') .example('$0 -d /dev/disk2 -y rpi.img') // Help option .help() // Version option .version(_.constant(packageJSON.version)) // Error reporting .fail((message, error) => { const errorObject = error || errors.createUserError({ title: message }) if (robot.isEnabled(process.env)) { robot.printError(errorObject) } else { yargs.showHelp() utils.printError(errorObject) } process.exit(EXIT_CODES.GENERAL_ERROR) }) // Assert that image exists .check((argv) => { const imagePath = argv._[IMAGE_PATH_ARGV_INDEX] try { fs.accessSync(imagePath) } catch (error) { throw errors.createUserError({ title: 'Unable to access file', description: `The image ${imagePath} is not accessible` }) } return true }) .check((argv) => { if (robot.isEnabled(process.env) && !argv.drive) { throw errors.createUserError({ title: 'Missing drive', description: 'You need to explicitly pass a drive when enabling robot mode' }) } return true }) // Assert that if the `yes` flag is provided, the `drive` flag is also provided. .check((argv) => { if (argv.yes && !argv.drive) { throw errors.createUserError({ title: 'Missing drive', description: 'You need to explicitly pass a drive when disabling interactively' }) } return true }) .options({ help: { describe: 'show help', boolean: true, alias: 'h' }, version: { describe: 'show version number', boolean: true, alias: 'v' }, drive: { describe: 'drive', string: true, alias: 'd' }, check: { describe: 'validate write', boolean: true, alias: 'c', default: true }, yes: { describe: 'confirm non-interactively', boolean: true, alias: 'y' }, unmount: { describe: 'unmount on success', boolean: true, alias: 'u', default: true } }) .parse(process.argv.slice(OPTIONS_INDEX_START))