/* * 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 path = require('path'); const yargs = require('yargs'); const utils = require('./utils'); const EXIT_CODES = require('../src/exit-codes'); const packageJSON = require('../../package.json'); /** * @summary Parsed CLI options and arguments * @type Object * @public */ module.exports = yargs .demand(1, 'Missing image') // Usage help .usage('Usage: $0 ') .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-cli/issues/new', ' Gitter: https://gitter.im/resin-io/chat' ].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) => { yargs.showHelp(); utils.printError(error || message); process.exit(1); }) // Assert that image exists .check((argv) => { fs.accessSync(argv._[0]); return true; }) .check((argv) => { if (argv.robot && !argv.drive) { throw new Error('Missing drive'); } return true; }) .check((argv) => { if (argv.log && !argv.robot) { throw new Error('The `--log` option requires `--robot`'); } 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 }, robot: { describe: 'parse-able output without interactivity', boolean: true, alias: 'r' }, log: { describe: 'output log file', string: true, alias: 'l' }, yes: { describe: 'confirm non-interactively', boolean: true, alias: 'y' }, unmount: { describe: 'unmount on success', boolean: true, alias: 'u', default: true } }) // Make sure arguments are parsed correctly when running // in development mode (or NPM) and in a final package. // // We rely on the following heuristics to determine if the // Etcher CLI is being run as a final packaged executable // or by a tool passing the script as an argument: .parse(_.attempt((argv) => { // Excluding the extension makes sure we cover cases // like *.exe and *.cmd in Windows systems. const executable = path.basename(argv[0], path.extname(argv[0])).toLowerCase(); if (_.includes([ 'node', 'electron', 'electron helper' ], executable)) { // In this case, the second argument (e.g: index 1) // equals `lib/cli/etcher.js`, so the real arguments // start from the third one. return argv.slice(2); } // Handle the case where the CLI is executed by pointing // the packaged electron `Etcher` binary to the application // asar archive by using `ELECTRON_RUN_AS_NODE`. if (argv[1] && path.basename(argv[1]) === 'app.asar') { return argv.slice(2); } return argv.slice(1); }, process.argv));