verb/lib/filters/safename.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 _ = require('lodash');

module.exports = function(verb) {
  verb.options = verb.options || {};

  exports.safename = function (name, options) {
    var opts = _.extend({}, verb.options, options || {});
    return verb.utils.safename(name, opts);
  };

  // Alias as `shortname()`
  exports.shortname = exports.safename;

  return exports;
};