patriot/lib/patriot/create.js

Patriot command-line interface and node.js library.

/*!
 * Module dependencies.
 */

var Command = require('./util/command'),
    cordova = require('cordova'),
    shell = require('shelljs'),
    path = require('path'),
    util = require('util');

/*!
 * Command setup.
 */

module.exports = {
    create: function(patriot) {
        return new CreateCommand(patriot);
    }
};

function CreateCommand(patriot) {
    return Command.apply(this, arguments);
}

util.inherits(CreateCommand, Command);

/**
 * Create a New App.
 *
 * Creates an project on the local filesystem.
 * This project is backwards compatible with Apache Cordova projects.
 *
 * Options:
 *
 *   - `options` {Object} is data required to create an app
 *     - `path` {String} is a directory path for the app.
 *     - `name` {String} is the application name (default: 'Hello World')
 *     - `id` {String} is the package name (default: 'com.patriot.hello-world')
 *   - [`callback`] {Function} is triggered after creating the app.
 *     - `e` {Error} is null unless there is an error.
 *
 * Returns:
 *
 *   {Patriot} for chaining.
 */

CreateCommand.prototype.run = function(options, callback) {
    // require options
    if (!options) throw new Error('requires option parameter');
    if (!options.path) throw new Error('requires option.path parameter');

    // optional callback
    callback = callback || function() {};

    // validate options
    options.path = path.resolve(options.path);
    options.name = options.name || 'Hybreed';
    options.id = options.id || 'com.atsistemas.Hybreed';

    // create app
    this.execute(options, callback);

    return this.patriot;
};

/*!
 * Execute.
 */

CreateCommand.prototype.execute = function(options, callback) {
    var self = this,
        version = self.patriot.version().patriot,
        uri = 'https://github.com/cordova/cordova-app-hello-world/archive/' +
              version + '.tar.gz';

    // customize default app
    cordova.config(options.path, {
        lib: {
            www: {
                id: options.id,
                version: version,
                uri: uri
            }
        }
    });

    // create local project
    cordova.create(options.path, options.id, options.name, function(e) {
        if (e) {
            self.patriot.emit('error', e);
            callback(e);
            return;
        }

        self.patriot.emit('log', 'created project at', options.path);
        callback(null);
    });
};