helper-copyright

helper-copyright

Template helper for adding a basic, one-line copyright statement, with formatting appropriate for LICENSE/LICENSE-MIT or README templates. Used with Verb, but should work with any Handlebars, Lo-Dash, underscore, or any template engine that allows helper functions to be registered.

Install

Install with npm:

$ npm install --save helper-copyright

Usage

var copyright = require('helper-copyright');
var handlebars = require('handlebars');

// the top-level export is a function that must be called, so you 
// can optionally pass an options object when registering the helper
handlebars.registerHelper('copyright', copyright({linkify: true}));

Example

Add a copyright statement, with author and year(s) in effect (verb templates):

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
//=> Copyright (c) 2017 Jon Schlinkert

Copyright © 2014, 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
//=> Copyright (c) 2014-2017 Jon Schlinkert

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
//=> Copyright (c) 2017 [Jon Schlinkert](https://github.com/jonschlinkert)

Examples

This should work with any engine, here are a few examples

Given the following locals:

var locals = {author: {name: 'Jon Schlinkert', url: 'https://github.com/jonschlinkert'}};

Lo-Dash

As a helper:

_.template('<%= copyright({author: author}) %>', locals, {
  imports: {'helper-copyright': require('helper-copyright')}
});
//=> Copyright (c) 2017 Jon Schlinkert

As a mixin:

_.mixin({'helper-copyright': require('helper-copyright')});
_.template('<%= copyright({author: author}) %>', locals);
//=> Copyright (c) 2017 Jon Schlinkert

template

template.helper('helper-copyright', require('helper-copyright'));
template.render('<%= copyright() %>', function(err, content) {
  console.log(content);
  //=> Copyright (c) 2017 Jon Schlinkert'
});

assemble

assemble.helper('helper-copyright', require('helper-copyright'));
assemble.render('{{copyright this}}', function(err, content) {
  console.log(content);
  //=> Copyright (c) 2017 Jon Schlinkert'
});

verb

verb.helper('helper-copyright', require('helper-copyright'));
verb.render('Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).', function(err, content) {
  console.log(content);
  //=> Copyright (c) 2017 Jon Schlinkert'
});

handlebars

var handlebars = require('handlebars');
handlebars.registerHelper('helper-copyright', require('helper-copyright'));
handlebars.compile('{{copyright this}}')(locals);
//=> Copyright (c) 2017 Jon Schlinkert

About

Related projects

• helper-license: Template helper for adding a formatted license statement based on the license type in package.json. | homepage
• helper-reflinks: Async template helper for generating a list of markdown reference links. | homepage
• helper-related: Template helper for generating a list of links to the homepages of related GitHub/npm projects. | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
53	jonschlinkert
1	ierceg
1	mightyiam

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.3.0, on January 08, 2017.