1. module publish
   1. function publish (options, callback)
   2. function publish.localPackage (callback)
   3. function publish.remoteVersion (localPackage, callback)
   4. function publish.shouldPublish (options, localVersion, remoteVersion)
   5. function publish.start (tagName, callback)

module publish

function publish (options, callback)

• description and source-code

  publish = function (options, callback) {
      localPackage(function(err, pkg) {
          if (err) {
              callback('publish can only be performed from the root of npm modules (where the package.json resides)');
          } else {
              var localVersion = pkg.version;
              if (localVersion == null) {
                  callback('you have not defined a version in your npm module, check your package.json');
              }
  
              remoteVersion(pkg, function(err, remoteVersion) {
                  if (err) {
                      callback(err);
                  } else if (shouldPublish(options, localVersion, remoteVersion) && !options.test) {
                      if (isTravis()) {
                          log.info('running in travis');
                          var npmUser = npmUserCredentials();
                          if (npmUser) {
                              npmAddUser(npmUser, function(err) {
                                  if (err) {
                                      callback('error while trying to add npm user in travis: ' + err);
                                  } else {
                                      npmPublish(callback);
                                  }
                              });
                          } else {
                              callback('npm user credentials not found, make sure NPM_USERNAME, NPM_PASSWORD and NPM_EMAIL environment
   variables are set');
                          }
                      } else {
                          npmPublish(callback);
                      }
                  }
              });
          }
      });
  }

• example usage

  ...
      });
  }
      });
  };
  
  
  function npmPublish(callback) {
      npm.commands.publish([], false, function (err, message) {
  if (err) {
  						log.error('publish failed:', message);
      callback(err);
  } else {
      log.info('published ok');
      callback();
  }
  ...

function publish.localPackage (callback)

• description and source-code

  function localPackage(callback) {
      try {
          callback(null, JSON.parse(fs.readFileSync('./package.json')));
      } catch (err) {
          callback(err);
      }
  }

• example usage

  n/a

function publish.remoteVersion (localPackage, callback)

• description and source-code

  function remoteVersion(localPackage, callback) {
      npm.commands.view([localPackage.name, 'version'], true, function (err, message) {
          if (err) {
              if (err.code === 'E404') {
                  callback('You have not published yet your first version of this module: publish will do nothing\n' +
                           'You must publish manually the first release of your module');
              } else {
                  callback(err);
              }
          } else {
              for (var remoteVersion in message) break;
  						if (remoteVersion) {
              		callback(null, remoteVersion);
  						} else {
  								callback('No version of this package has yet been published for tag "' + npm.config.get('tag') + '".\n' +
  										     'You must publish manually the first release of your module');
  						}
          }
      });
  }

• example usage

  n/a

function publish.shouldPublish (options, localVersion, remoteVersion)

• description and source-code

  function shouldPublish(options, localVersion, remoteVersion) {
      options = options || {};
  
      log.info('Local version: ' + localVersion);
      log.info('Published version: ' + remoteVersion);
      if (semver.eq(remoteVersion, localVersion)) {
          log.info('Your local version is the same as your published version: publish will do nothing');
          return false;
      } else if (semver.gt(remoteVersion, localVersion)) {
          log.warn('Your local version is smaller than your published version: publish will do nothing');
          return false;
      } else if (containsOnVersion(options)) {
          var diff = semver.diff(remoteVersion, localVersion);
          if (!options['on-' + diff]) {
              log.info('Your local version does not satisfy your --on-[major|minor|patch|build] options; publish will do nothing');
              return false;
          }
      }
  		log.info('Defined criteria met; publish will release a new version');
  		return true;
  }

• example usage

  n/a

function publish.start (tagName, callback)

• description and source-code

  start = function (tagName, callback) {
  		var loadOptions = {};
  		if (tagName) {
  				log.info('Using tag', tagName);
  				loadOptions.tag = tagName;
  		}
      npm.load(loadOptions, function (err) {
          callback(err, npm);
      });
  }

• example usage

  ...
   Please report bugs!  https://github.com/cmanzana/node-publish/issues
  
   */
  }.toString().split(/\n/).slice(1, -2).join('\n'));
  process.exit(0);
  }
  
  publish.start(options.tag, function(err) {
  if (err) {
      handleError(err);
  }
  
  publish.publish(options, function (err) {
      if (err) {
          handleError(err);
  ...