verb/lib/plugins/comments.js

Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.

'use strict';

var extend = require('extend-shallow');
var through = require('through2');
var PluginError = require('plugin-error');

module.exports = function() {
  var opts = extend({}, this.options, this.get('argv'));

  return through.obj(function (file, enc, cb) {
    if (file.isNull()) {
      this.push(file);
      return cb();
    }

    try {
      // strip code comments
      var str = file.contents.toString();
      str = stripHbsComments(str, opts);
      str = stripTmplComments(str, opts);
      str = stripHtmlComments(str, opts);

      // rebuffer contents
      file.contents = new Buffer(str);
      this.push(file);
      return cb();
    } catch (err) {
      this.emit('error', new PluginError('comments plugin', err, {stack: true}));
      return cb();
    }
  });
};

function stripHbsComments(str, opts) {
  return strip(str, '{{!', '}}', opts);
}

function stripTmplComments(str, opts) {
  return strip(str, '{{#', '#}}', opts);
}

function stripHtmlComments(str, opts) {
  str = strip(str, '<!-- strip', '-->', opts);
  return strip(str, '<!--strip', '-->', opts);
}

function strip(str, lt, rt, opts) {
  if (opts && opts.stripComments === false) return str;
  var a = str.indexOf(lt);
  var b = str.indexOf(rt, a);

  while (a !== -1 && b !== -1) {
    str = str.slice(0, a) + str.slice(b + rt.length);
    a = str.indexOf(lt);
    b = str.indexOf(rt, a);
  }
  return str;
}