1. module plugman
   1. function plugman.config ()
   2. function plugman.create ()
   3. function plugman.createpackagejson ()
   4. function plugman.emit ()
   5. function plugman.fetch ()
   6. function plugman.info ()
   7. function plugman.install ()
   8. function plugman.off ()
   9. function plugman.on ()
   10. function plugman.owner ()
   11. function plugman.platform ()
   12. function plugman.removeAllListeners ()
   13. function plugman.search ()
   14. function plugman.uninstall ()
   15. object plugman.commands
   16. object plugman.raw
2. module plugman.commands
   1. function plugman.commands.config (cli_opts)
   2. function plugman.commands.create (cli_opts)
   3. function plugman.commands.createpackagejson (cli_opts)
   4. function plugman.commands.info (cli_opts)
   5. function plugman.commands.install (cli_opts)
   6. function plugman.commands.owner (cli_opts)
   7. function plugman.commands.platform (cli_opts)
   8. function plugman.commands.publish ()
   9. function plugman.commands.search (cli_opts)
   10. function plugman.commands.uninstall (cli_opts)
   11. function plugman.commands.unpublish (cli_opts)

module plugman

function plugman.config ()

• description and source-code

  config = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.create ()

• description and source-code

  create = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.createpackagejson ()

• description and source-code

  createpackagejson = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.emit ()

• description and source-code

  emit = function () { [native code] }

• example usage

  n/a

function plugman.fetch ()

• description and source-code

  fetch = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.info ()

• description and source-code

  info = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.install ()

• description and source-code

  install = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.off ()

• description and source-code

  off = function () { [native code] }

• example usage

  n/a

function plugman.on ()

• description and source-code

  on = function () { [native code] }

• example usage

  ...
  // Without these arguments, the commands will fail and print the usage anyway.
  if (cli_opts.plugins_dir || cli_opts.project) {
      cli_opts.plugins_dir = typeof cli_opts.plugins_dir == 'string' ?
          cli_opts.plugins_dir :
          path.join(cli_opts.project, 'cordova', 'plugins');
  }
  
  process.on('uncaughtException', function(error) {
      if (cli_opts.debug) {
          console.error(error.message, error.stack);
      } else {
          console.error(error.message);
      }
      process.exit(1);
  });
  ...

function plugman.owner ()

• description and source-code

  owner = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.platform ()

• description and source-code

  platform = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.removeAllListeners ()

• description and source-code

  removeAllListeners = function () { [native code] }

• example usage

  n/a

function plugman.search ()

• description and source-code

  search = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

function plugman.uninstall ()

• description and source-code

  uninstall = function () {
      val = val || require(modulePath);
      if (arguments.length && typeof arguments[arguments.length - 1] === 'function') {
          // If args exist and the last one is a function, it's the callback.
          var args = Array.prototype.slice.call(arguments);
          var cb = args.pop();
          val.apply(o, args).done(function(result) {cb(undefined, result);}, cb);
      } else {
          val.apply(o, arguments).done(null, function(err){ throw err; });
      }
  }

• example usage

  n/a

module plugman.commands

function plugman.commands.config (cli_opts)

• description and source-code

  config = function (cli_opts) {
      plugman.config(cli_opts.argv.remain, function(err) {
          if (err) throw err;
          else console.log('done');
      });
  }

• example usage

  n/a

function plugman.commands.create (cli_opts)

• description and source-code

  create = function (cli_opts) {
      if( !cli_opts.name || !cli_opts.plugin_id || !cli_opts.plugin_version) {
          return console.log( plugman.help() );
      }
      var cli_variables = {};
      if (cli_opts.variable) {
          cli_opts.variable.forEach(function (variable) {
              var tokens = variable.split('=');
              var key = tokens.shift().toUpperCase();
              if (/^[\w-_]+$/.test(key)) cli_variables[key] = tokens.join('=');
          });
      }
      plugman.create( cli_opts.name, cli_opts.plugin_id, cli_opts.plugin_version, cli_opts.path || '.', cli_variables );
  }

• example usage

  n/a

function plugman.commands.createpackagejson (cli_opts)

• description and source-code

  createpackagejson = function (cli_opts) {
      var plugin_path = cli_opts.argv.remain[0];
      if(!plugin_path) {
          return console.log(plugman.help());
      }
      plugman.createpackagejson(plugin_path);
  }

• example usage

  n/a

function plugman.commands.info (cli_opts)

• description and source-code

  info = function (cli_opts) {
      plugman.info(cli_opts.argv.remain, function(err, plugin_info) {
          if (err) throw err;
          else {
              console.log('name:', plugin_info.name);
              console.log('version:', plugin_info.version);
              if (plugin_info.engines) {
                  for(var i = 0, j = plugin_info.engines.length ; i < j ; i++) {
                      console.log(plugin_info.engines[i].name, 'version:', plugin_info.engines[i].version);
                  }
              }
          }
      });
  }

• example usage

  n/a

function plugman.commands.install (cli_opts)

• description and source-code

  install = function (cli_opts) {
      if(!cli_opts.platform || !cli_opts.project || !cli_opts.plugin) {
          return console.log(plugman.help());
      }
      if(cli_opts.browserify === true) {
          plugman.prepare = require('./prepare-browserify');
      }
      var cli_variables = {};
  
      if (cli_opts.variable) {
          cli_opts.variable.forEach(function (variable) {
              var tokens = variable.split('=');
              var key = tokens.shift().toUpperCase();
              if (/^[\w-_]+$/.test(key)) cli_variables[key] = tokens.join('=');
          });
      }
      var opts = {
          subdir: '.',
          cli_variables: cli_variables,
          fetch: cli_opts.fetch || false,
          save: cli_opts.save || false,
          www_dir: cli_opts.www,
          searchpath: cli_opts.searchpath,
          link: cli_opts.link,
          projectRoot: cli_opts.project
      };
      var p = Q();
      cli_opts.plugin.forEach(function (pluginSrc) {
          p = p.then(function () {
              return plugman.raw.install(cli_opts.platform, cli_opts.project, pluginSrc, cli_opts.plugins_dir, opts);
          });
      });
  
      return p;
  }

• example usage

  n/a

function plugman.commands.owner (cli_opts)

• description and source-code

  owner = function (cli_opts) {
      plugman.owner(cli_opts.argv.remain);
  }

• example usage

  n/a

function plugman.commands.platform (cli_opts)

• description and source-code

  platform = function (cli_opts) {
      var operation = cli_opts.argv.remain[ 0 ] || '';
      if( ( operation !== 'add' && operation !== 'remove' ) ||  !cli_opts.platform_name ) {
          return console.log( plugman.help() );
      }
      plugman.platform( { operation: operation, platform_name: cli_opts.platform_name } );
  }

• example usage

  n/a

function plugman.commands.publish ()

• description and source-code

  publish = function () {
      events.emit('error', 'The publish functionality is not supported anymore since the Cordova Plugin registry\n' +
          'is moving to read-only state. For publishing use corresponding \'npm\' commands.\n\n' +
          'If for any reason you still need for \'plugman publish\' - consider downgrade to plugman@0.23.3');
  }

• example usage

  n/a

function plugman.commands.search (cli_opts)

• description and source-code

  search = function (cli_opts) {
      plugman.search(cli_opts.argv.remain, function(err, plugins) {
          if (err) throw err;
          else {
              for(var plugin in plugins) {
                  console.log(plugins[plugin].name, '-', plugins[plugin].description || 'no description provided');
              }
          }
      });
  }

• example usage

  n/a

function plugman.commands.uninstall (cli_opts)

• description and source-code

  uninstall = function (cli_opts) {
      if(!cli_opts.platform || !cli_opts.project || !cli_opts.plugin) {
          return console.log(plugman.help());
      }
  
      if(cli_opts.browserify === true) {
          plugman.prepare = require('./prepare-browserify');
      }
  
      var p = Q();
      cli_opts.plugin.forEach(function (pluginSrc) {
          var opts = {
              www_dir: cli_opts.www,
              save: cli_opts.save || false,
              fetch: cli_opts.fetch || false,
              projectRoot: cli_opts.project
          };
          p = p.then(function () {
              return plugman.raw.uninstall(cli_opts.platform, cli_opts.project, pluginSrc, cli_opts.plugins_dir, opts);
          });
      });
  
      return p;
  }

• example usage

  n/a

function plugman.commands.unpublish (cli_opts)

• description and source-code

  unpublish = function (cli_opts) {
      events.emit('error', 'The publish functionality is not supported anymore since the Cordova Plugin registry\n' +
          'is moving to read-only state. For publishing/unpublishing use corresponding \'npm\' commands.\n\n' +
          'If for any reason you still need for \'plugman unpublish\' - consider downgrade to plugman@0.23.3');
  }

• example usage

  n/a