Generate Atom snippet documentation from a package's CSON files

docs.js

/**
 * Convert cson snippets into a Markdown document for reference
 */
const cson = require('cson');
const glob = require ('glob');
const path = require('path');
const fs   = require('fs');
const _    = require('lodash');

function Snippet(title, code, prefix, fileName, lang) {
  this.title = title;
  this.code = code;
  this.prefix = prefix;
  this.fileName = fileName;
  this.lang = this.getCodeLanguage(lang);
}

Snippet.prototype.getFormattedCode = function () {
  return this.code.replace(/\\\\/g, '\\');
};

/**
 * Parse the language from the snippet's root source type (eg `.source.php`)
 */
Snippet.prototype.getCodeLanguage = function (lang) {
  var lang = lang.split('.');

  lang = lang[lang.length - 1];
  lang = (lang == '*' || lang == '') ? '' : lang;

  return lang;
}

// Process snippets and generate markdown reference document
glob('./snippets/**/*.cson', (err, files) => {
  var snippets = [];
  var template = fs.readFileSync('./doc/snippet.jst').toString();
  var compiled = _.template(template);

  files.forEach(file => {
    var fileName = path.parse(file).base;
    var parsed = cson.parseCSONFile(file);

    Object.keys(parsed).forEach(key => {
      Object.keys(parsed[key]).forEach(title => {
        var s = parsed[key][title];
        snippets.push(new Snippet(title, s.body, s.prefix, fileName, key));
      });
    });
  });

  fs.writeFile('./doc/snippet-reference.markdown', compiled({ snippets: snippets }), (err) => {
      if (err) {
          return console.log(err);
      }
      console.log("The ./doc/snippet-reference.mardown file was saved");
  });

});