helper-license

helper-license

Template helper for dynamically generating a basic, one-line license statement based on the given context, e.g. Released under the MIT license. Should work with any Handlebars, Lo-Dash, underscore, or any template engine that allows helper functions to be registered.

Install with npm

npm i helper-license --save

Usage example

Add a basic license statement to a document with verb:

{%= license() %}
//=> Released under the MIT license

{%= license({linkify: true}) %}
//=> Released under the [MIT](https://github.com/jonschlinkert/helper-license/blob/master/LICENSE-MIT) license

Other engines/apps

Add a basic license statement

var pkg = require('./package.json');

// handlebars
Handlebars.compile('{{license this}}')(pkg);
// lo-dash
_.template('<%= license({licenses: licenses}) %>', )
// verb
verb.render('{%= license({licenses: licenses}) %}', pkg);

// all result in:
//=> Released under the MIT license

Linkify:

_.template('<%= license({licenses: licenses, linkify: true}) %>', pkg);
//=> Released under the [MIT](https://github.com/jonschlinkert/helper-license/blob/master/LICENSE-MIT) license

Registering the helper

This should work with any engine, here are a few examples to get you started

template

template.helper('license', require('helper-license'));

assemble

assemble.helper('license', require('helper-license'));

verb

verb.helper('license', require('helper-license'));

handlebars

var handlebars = require('handlebars');
handlebars.registerHelper('license', require('helper-license'));

Related projects

• helper-copyright: Template helper for adding a basic, one-line copyright statement, with… more
• helper-reflinks: Template helper for generating a list of markdown formatted reference… more
• helper-related: Template helper for generating a list of links to the… more
• template-helpers: Generic JavaScript helpers that can be used with any template… more
• verb: Verb makes it dead simple to generate markdown documentation, using… more

Running tests

Install dev dependencies:

npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

---

This file was generated by verb-cli on April 23, 2015.