index.js

"use strict";

/* eslint no-process-exit:0 */

var optimist = require("optimist");
var ttys = require("ttys");
var _ = require("lodash");

var help = require("./lib/help");
var commands = require("./lib/commands");
var checkEnv = require("./lib/check-env");
var config = require("./lib/config");


module.exports = safeMain;


// We need to regenerate optimist options if --help or -h is encountered
function getOpts (processArgv) {
  return optimist(processArgv)
    .usage(help())
    // Show version
    .boolean("version")
    .describe("version", "Show version and exit")
    // Help options (converted to help command)
    .boolean("h")
    .describe("h", "Show help")
    .alias("h", "help")
    // Update notification control
    .boolean("no-notifier")
    .describe("no-notifier", "Disable update notifier");
}

// Check for package update
function checkUpdate () {
  var pkg = require("./package.json");
  require("update-notifier")({
    packageName:    pkg.name,
    packageVersion: pkg.version
  }).notify();
}

// Show version and exit
function showVersion () {
  var pkg = require("./package.json");
  console.log(pkg.version);
  process.exit(0);
}

// Transform CLI args to convert --help && -h into help command
function transformHelpArgs (processArgv) {
  var args = (processArgv || []).slice();

  // Remove "--help" and "-h" from args
  var longIndex = args.indexOf("--help");
  if (longIndex !== -1) {
    args.splice(longIndex, 1);
  }
  var shortIndex = args.indexOf("-h");
  if (shortIndex !== -1) {
    args.splice(shortIndex, 1);
  }

  // Replace `$0 …` by `$0 help …`
  args.unshift("help");

  return args;
}

// Main execution, after env has been checked
function main (processArgv, conf) {

  // CLI input
  var opts = getOpts(processArgv);
  var argv = opts.argv;

  // Update notifier
  if (!argv["no-notifier"]) {
    checkUpdate();
  }

  // Convert options "--help" and "-h" into command "help"
  if (argv.help) {
    processArgv = transformHelpArgs(processArgv);
    // Regenerate opts from newly forged process.argv
    opts = getOpts(processArgv);
    argv = opts.argv;
  }

  // "--version"
  if (argv.version) {
    showVersion();
  }

  var commandName = argv._[0];

  // Demand command name
  if (!commandName) {
    console.error("No command specified");
    opts.showHelp();
    process.exit(127);
  }

  // Load command module
  var command = commands.load(commandName);

  // Demand valid command
  if (!command) {
    console.error("Unknown command: " + commandName);
    opts.showHelp();
    process.exit(127);
  }

  process.on("exit", function () {
    ttys.stdin.end();
  });

  // Configure opts and run command (inside a domain to catch any error)
  commands.run(command, opts, conf).then(ok, fail);

  function ok () {
    process.exit(0);
  }

  function fail (e) {
    if (e.code === "EINTERRUPT") {
      process.exit(127);
    } else {
      console.error("%s", e);
      if (process.env.DEBUG) {
        throw e;
      }
      process.exit(1);
    }
  }
}

// Main execution
// processArgv = CLI args === process.argv.slice(2)
function safeMain (processArgv) {
  // Benchmark
  if (process.env.TIME) {
    var start = Date.now();
    console.log("[Github-Todos] Start…");
    process.on("exit", function () {
      var diff = Date.now() - start;
      console.log("[Github-Todos] Execution time: %d ms", diff);
    });
  }

  // Disabled?
  if (process.env.NO_GITHUB_TODOS) {
    console.log("[Github-Todos] Disabled from environment");
    process.exit(0);
    return;
  }

  // Check env then execute
  checkEnv()
    .then(null, function (err) {
      console.error("Error found in your current environment: %s", err);
      if (process.env.DEBUG) {
        console.error(err.stack);
      }
      process.exit(2);
    })
    .then(function () {
      return config.list();
    })
    .then(_.partial(main, processArgv));
}