ionic/lib/ionic/start.js

A tool for creating and developing Ionic Framework mobile apps.

require('shelljs/global');

var chalk = require('chalk');
var extend = require('../utils/extend');
var fs = require('fs');
var Q = require('q');
var templateUtils = require('../utils/templates');
var IonicAppLib = require('ionic-app-lib');
var Start = IonicAppLib.start;
var log = IonicAppLib.logging.logger;
var appLibUtils = IonicAppLib.utils;

var StartWizard = IonicAppLib.start_wizard;

var settings = {
  title: 'start',
  name: 'start',
  summary: 'Starts a new Ionic project in the specified PATH',
  args: {
    '[options]': 'any flags for the command',
    '<PATH>': 'directory for the new project',
    '[template]': 'Starter templates can either come from a named template, \n' +
                  '(ex: tabs, sidemenu, blank),\n' +
                  'a Github repo, a Codepen url, or a local directory.\n' +
                  'Codepen url, ex: http://codepen.io/ionic/pen/odqCz\n' +
                  'Defaults to Ionic "tabs" starter template'
  },
  options: {
    '--appname|-a': 'Human readable name for the app (Use quotes around the name)',
    '--id|-i': 'Package name for <widget id> config, ex: com.mycompany.myapp',
    '--skip-npm': {
      title: 'Skip npm package installation',
      boolean: true
    },
    '--no-cordova|-w': {
      title: 'Create a basic structure without Cordova requirements',
      boolean: true
    },
    '--sass|-s': {
      title: 'Setup the project to use Sass CSS precompiling',
      boolean: true
    },
    '--list|-l': {
      title: 'List starter templates available',
      boolean: true
    },
    '--io-app-id': 'The Ionic.io app ID to use',
    '--template|-t': 'Project starter template',
    '--v1': {
      boolean: true,
      title: 'Start an Ionic v1 project'
    },
    '--zip-file|-z': 'URL to download zipfile for starter template'
  },
  isProjectTask: false
};

function run(ionic, argv) {
  if (argv.list || argv.l) {
    return templateUtils.listTemplates();
  }

  if (argv._.length < 2 && StartWizard) {
    return StartWizard.start();
  } else if(argv._length < 2) {
    return appLibUtils.fail('Invalid command', 'start');
  }

  if (argv._[1] === '.') {
    return log.error(chalk.red('Please name your Ionic project something meaningful other than \'.\''));
  }


  // Ensure that the folder name provided is a String
  // ie 5 becomes '5' AND '5' stays as '5'
  argv._[1] = argv._[1].toString();


  // This is temporary.... because I don't want to update app scripts before CLI v3 release
  // If defined as v1 in command line then remove the v2 flag
  // If no option or v2 option is passed then set the v2 flag
  argv.v2 = !argv.v1;

  var promptPromise;
  var options = appLibUtils.preprocessCliOptions(argv);
  var startingApp = true;

  // Grab the app's relative directory name
  if (fs.existsSync(options.targetPath)) {
    promptPromise = Start.promptForOverwrite(options.targetPath);
  } else {
    promptPromise = Q(true);
  }

  return promptPromise
  .then(function(promptToContinue) {
    if (!promptToContinue) {
      startingApp = false;
      log.info('\nIonic start cancelled by user.');
      return;
    }
    return Start.startApp(options);
  })
  .then(function() {
    if (startingApp) {
      return Start.printQuickHelp(options);
    }
  })
  .then(function() {
    if (startingApp) {
      return Start.promptLogin(options);
    }
  })
  .then(function() {
    if (options.v2 && startingApp) {
      //log.info('\nNew to Ionic? Get started here: http://ionicframework.com/getting-started\n');
    }
  })
  .catch(function(error) {
    log.error(error);
    throw error;
  });
}

module.exports = extend(settings, {
  run: run
});