verb/lib/tags/copyright.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.
 */

module.exports = function(verb) {
  var context = verb.context;

  /**
   * Add a copyright statement, with author and year(s) in effect.
   * @param  {Number} startYear Optional parameter to define the start year of the project.
   * @return {String}           Complete copyright statement.
   * @example
   *   {%= _.copyright() %} => Copyright (c) 2014 Jon Schlinkert, contributors.
   *   {%= _.copyright('2012') %} => Copyright (c) 2012-2014 Jon Schlinkert, contributors.
   */

  var author;
  if(context.author && context.author.name) {
    author = context.author.name;
  } else if (context.author && typeof context.author === 'string') {
    author = context.author;
  }

  exports.copyright = function (startYear) {
    var today = new Date().getFullYear();
    var date = startYear ? startYear + '-' + today : today;
    // Keep the spaces at the end to ensure that a newline is used by gfm
    verb.context.copyright = 'Copyright (c) '+date+' '+author+', contributors.  ';
    return verb.context.copyright;
  };

  return exports;
};