verb/lib/utils/block.js

A project without documentation is like a project that doesn't exist. Verb solves this by making it dead simple to generate docs, using simple markdown templates, with zero configuration required.

/**
 * Verb <https://github.com/assemble/verb>
 * Generate markdown documentation for GitHub projects.
 *
 * Copyright (c) 2014 Jon Schlinkert, Brian Woodward, contributors.
 * Licensed under the MIT license.
 */

const frep = require('frep');
const delims = require('delims');
const template = require('../template');


/**
 * TODO: This isn't used anywhere.
 * Move it to example for delims!
 */

function makeDelims(delimiters) {
  var defaults = {body: '', flags: 'gm'};
  return delims(delimiters, defaults).evaluate;
}

function makeBlock(name) {
  var s = '\\s*';
  return [
    '\\{{2}('+s+name+s+')([\\S]+)'+s+'\\}{2}',
    '\\{{2}/('+s+name+s+')\\}{2}'
  ];
}

module.exports = function(verb) {

  /**
   * Create a block template
   *
   * @return {String}
   * @api public
   */
  exports.block = function(str) {
    var blocks = [
      {
        pattern: makeDelims(makeBlock('block')),
        replacement: function (_, tag, context, inner) {
          context = verb.context[context];
          return template(inner, context);
        }
      }
    ];
    return frep.strWithArr(str, blocks);
  };
  return exports;
};