serverless/scripts/generate-readme.js

'use strict';

/**
 * adds content to the repos README.md file
 */
const path = require('path');
const url = require('url');
const markdownMagic = require('markdown-magic');
const remoteRequest = require('markdown-magic/lib/utils/remoteRequest');

function toTitleCase(str) {
  return str.replace(/\w\S*/g, txt =>
     txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase()
  );
}

function formatPluginName(string) {
  return toTitleCase(string.replace(/-/g, ' '));
}

function username(repo) {
  if (!repo) {
    return null;
  }

  const o = url.parse(repo);
  var urlPath = o.path; // eslint-disable-line

  if (urlPath.length && urlPath.charAt(0) === '/') {
    urlPath = urlPath.slice(1);
  }

  urlPath = urlPath.split('/')[0];
  return urlPath;
}

const config = {
  transforms: {
    GENERATE_SERVERLESS_EXAMPLES_TABLE(content, options) { // eslint-disable-line
      const examplesUrl = 'https://raw.githubusercontent.com/serverless/examples/master/community-examples.json';
      const remoteContent = remoteRequest(examplesUrl);
      var md = '| Project Name | Author |\n'; // eslint-disable-line
      md += '|:-------------|:------:|\n';
      JSON.parse(remoteContent).forEach((data) => {
        const userName = username(data.githubUrl);
        const profileURL = `http://github.com/${userName}`;
        md += `| **[${formatPluginName(data.name)}](${data.githubUrl})** <br/>`;
        md += ` ${data.description} | [${userName}](${profileURL}) | \n`;
      });
      return md.replace(/^\s+|\s+$/g, '');
    },
    GENERATE_SERVERLESS_PLUGIN_TABLE(content, options) { // eslint-disable-line
      const pluginUrl = 'https://raw.githubusercontent.com/serverless/plugins/master/plugins.json';
      const remoteContent = remoteRequest(pluginUrl);
      var md = '| Plugin | Author |\n'; // eslint-disable-line
      md += '|:-------|:------:|\n';
      JSON.parse(remoteContent).sort((a, b) =>  // eslint-disable-line
         a.name < b.name ? -1 : 1
      ).forEach((data) => {
        const userName = username(data.githubUrl);
        const profileURL = `http://github.com/${userName}`;
        md += `| **[${formatPluginName(data.name)}](${data.githubUrl})** <br/>`;
        md += ` ${data.description} | [${userName}](${profileURL}) | \n`;
      });
      return md.replace(/^\s+|\s+$/g, '');
    },
  },
};

const markdownPath = path.join(__dirname, '..', 'README.md');
// const markdownPath = path.join(__dirname, '..', 'test/fixtures/test.md')
markdownMagic(markdownPath, config, () => {
  console.log(`${markdownPath} updated!`); // eslint-disable-line
});