homie-device/bin/contributors.js

Homie Device for NodeJS

#!/usr/local/bin/node
/**
* Merge current contributors into the README.md file
*/
var request = require('request'),
    _ = require('lodash'),
    fs = require('fs');

// Constants
REPO = 'lorenwest/homie-device';
README_FILE = './README.md';

// HTML template parts
_.templateSettings = {
  interpolate : /\{\{(.+?)\}\}/g
};
var TABLE_TEMPLATE = _.template('<table id="contributors">{{rows}}</table>');
var ROW_TEMPLATE = _.template('<tr>{{people}}</tr>');
var PERSON_TEMPLATE = _.template('<td><img width="124" src="{{avatar_url}}"><br/><a href="{{html_url}}">{{login}}</a></td>');
var PEOPLE_PER_ROW = 6;

// Read the contributor list from github, return as an HTML table
function getContributorTable(callback) {
  var options = {
    url: 'https://api.github.com/repos/' + REPO + '/contributors',
    headers: {
      'User-Agent': 'README.md contributor generator, github/lorenwest'
    }
  }
  request(options, function(error, response, body) {
    if (error) {
      console.error('Cannot load contributor list', error);
      process.exit(1);
    }
    var contributors;
    try {
      contributors = JSON.parse(body);
    } catch (e) {
      console.error('Error loading contribtor list: ' + body);
    }

    // Un-comment to show what github spits out
    // console.log(JSON.stringify(contributors,null,2));

    // Process each contributor
    var rows = [];
    var row = [];
    for (var contributorNum in contributors) {
      var contributor = contributors[contributorNum];
      if (row.length === PEOPLE_PER_ROW) {
        rows.push(ROW_TEMPLATE({people:row.join('')}));
        row = [];
      }
      row.push(PERSON_TEMPLATE(contributor));
    }

    // Add the last row and return the table
    rows.push(ROW_TEMPLATE({people:row.join('')}));
    callback(null, TABLE_TEMPLATE({rows: rows.join('')}));
  });
};


// Get the contributor table, then merge
getContributorTable(function(error, htmlTable) {
  if (error) {
    console.error('Not complete.  Exiting.');
    process.exit(1);
  }

  // Replace the contributor table
  var fileLines = fs.readFileSync(README_FILE).toString().split('\n');
  for (var i in fileLines) {
    if (fileLines[i].indexOf('<table id="contributors"') === 0) {
      fileLines[i] = htmlTable;
      fs.writeFileSync(README_FILE, fileLines.join('\n'));
      console.log('Contributor table replaced.');
      process.exit(0);
    }
  }
  console.error('Error: No contributors table found to replace');
});