@adobe/jsonschema2md/lib/readmeWriter.js

Validate and document complex JSON Schemas the easy way.

/**
 * Copyright 2017 Adobe Systems Incorporated. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 */

const writeFile = require('./writeFiles');
var Promise=require('bluebird');
var _ = require('lodash');
var ejs = require('ejs');
var path = require('path');
const pejs = Promise.promisifyAll(ejs);
var validUrl = require('valid-url');

function relativePath(full, base) {
  if (full.indexOf(base)===0) {
    return full.substr(base.length).replace(/\.schema\.json$/, '');
  } else {
    return full;
  }
}

function directory(full, base) {
  return relativePath(full, base).replace(/[^\/]+$/, '');
}

/**
 * Generates a README.md file from the `schemas` passed in at directory `out`
 * @param {array[string]} paths - path of generated markdown files
 * @param {map} schemas - map of resolved schemas
 * @param {string} out - output directory
 * @param {string} base - schema base directory
 */
const generateReadme = function(paths, schemas, out, base) {
  const coreinfo = _.values(schemas).map(schema => {
    return {
      id: schema.jsonSchema.$id,
      title: schema.jsonSchema.title,
      full: schema.filePath,
      relative: relativePath(schema.filePath, base),
      dir: directory(schema.filePath, base),
    };
  });
  const ctx = {
    paths: paths,
    _: _,
    validUrl: validUrl,
    schemas: schemas,
    core: coreinfo,
    groups: _.groupBy(coreinfo, key => { return key.dir; })
  };

  return pejs.renderFileAsync(path.join(__dirname, '../templates/md/readme.ejs'), ctx, { debug: false }).then(str => {
    console.log('Writing README');
    return writeFile(out, 'README.md', str);
  }).then(out => {
    //console.log('markdown written (promise)', out);
    return out;
  });
};

module.exports = generateReadme;