ghpages/index.js

A command-line tool to easily deploy your current working branch to GitHub Pages.

var fs = require('fs');
var path = require('path');
var spawn = require('child_process').spawn;

var gitconfig = require('gitconfiglocal');
var ghpages = require('gh-pages');
var ghUrl = require('parse-github-url');

function lower (str) {
  return (str || '').toLowerCase().trim();
}

function getCacheDir (ghUser, ghRepo, ghBranch) {
  var pathAbsolute = path.resolve(
    __dirname, '.cache', lower(ghUser), lower(ghRepo), lower(ghBranch));
  return path.relative(process.cwd(), pathAbsolute);
}

module.exports = function (opts, cb) {
  // TODO: Document this CLI option and probably rename it to `path`.
  var cwd = opts.dir || process.cwd();

  // Parse the project's `package.json` so we can use the `repository` key.
  var pkg = {};
  try {
    pkg = require(path.join(cwd, 'package.json'));
  } catch (e) {
  }
  var pkgRepo = pkg.repository || '';
  var repoUrl = typeof pkgRepo === 'string' ? pkgRepo : pkgRepo.url;
  if (repoUrl) {
    deploy();
    return;
  }

  gitconfig(cwd, function (err, config) {
    if (err) { console.warn('gitconfig error: %s', err); }

    try {
      repoUrl = config.remote.origin.url;
    } catch (e) {}

    if (repoUrl) {
      deploy();
      return;
    }

    return cb(new Error('Expected a valid `repository` in the ' +
      '`package.json` or `remote.origin.url` in the Git repo.'));
  });

  function deploy () {
    var gh = ghUrl(repoUrl);

    if (process.env.GHPAGES_REPO) {
      parseRepo(process.env.GHPAGES_REPO);
    } else if (opts.repo) {
      parseRepo(opts.repo);
    }

    function parseRepo (repo) {
      if (repo.indexOf('/') === -1) {
        // If it doesn't contain a `/`, we assume only the username is different.
        gh.user = repo;
        gh.repopath = gh.user + '/' + gh.repo;
      } else {
        // Otherwise, assume it's a parsable Git(Hub) URL.
        gh = ghUrl(repo);
      }
    }

    gh.branch = 'gh-pages';

    // TODO: Add a `CNAME` file in the directory before we push.
    // if (opts.domain) {
    //   fs.writeFileSync(path.join(opts.cwd, 'CNAME'), opts.domain);
    // }

    // Reconstruct the URL to the GitHub repo.
    gh.repoUrl = 'git@github.com:' + gh.repopath + '.git';
    gh.ghPagesHost = gh.user + '.github.io';

    var CNAME = path.join(cwd, 'CNAME');
    if (fs.existsSync(CNAME)) {
      gh.ghPagesUrl = fs.readFileSync(CNAME);
    }

    gh.ghPagesUrl = 'https://' + gh.ghPagesHost + '/';

    if (gh.repo === gh.ghPagesHost) {
      gh.branch = 'master';
    } else {
      gh.pagesUrl += gh.repo + '/';
    }

    var src = path.join(cwd, opts.path);

    // ghpages.clean();  // Wipe out the checkout from scratch every time in case we change repos.

    ghpages.publish(path.join(cwd, opts.path), {
      clone: getCacheDir(gh.user, gh.repo, gh.branch),
      repo: gh.repoUrl,
      branch: gh.branch,
      dotfiles: false,
      logger: console.log.bind(console)
    }, function (err) {
      cb(err, gh);
    });
  }
};