serverless/scripts/generate-readme.js

/**
 * This example generated adds content to the repos README.md file
 */
const fs = require('fs')
const path = require('path')
const fetch = require('node-fetch')
const markdownMagic = require('markdown-magic')
const remoteRequest = require('markdown-magic/lib/transforms/remote').remoteRequest

const config = {
  transforms: {
    GENERATE_SERVERLESS_PLUGIN_TABLE: function(content, options) {
      const pluginUrl = 'https://raw.githubusercontent.com/serverless/community-plugins/master/plugins.json'
      const remoteContent = remoteRequest(pluginUrl)
      let md =  '| Plugin name | description  |\n'
          md += '|:--------------------------- |:-----|\n'
      JSON.parse(remoteContent).plugins.sort(function (a, b) {
          return a.name < b.name ? -1 : 1;
      }).forEach(function(data) {
          md += `| [${formatPluginName(data.name)}](${data.githubUrl}) | ${data.description} |\n`
      });
      return md.replace(/^\s+|\s+$/g, '')
    }
  }
}

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

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

const markdownPath = path.join(__dirname, '..', 'README.md')
// const markdownPath = path.join(__dirname, '..', 'test/fixtures/test.md')
markdownMagic(markdownPath, config, function() {
  console.log(`${markdownPath} updated!`)
})