licensify

Browserify plugin to prepend license header to your bundle

DESCRIPTION

licensify is a Browserify plugin to prepend license header to your bundle as follows.

/**
 * Modules in this bundle
 * @license
 * 
 * licensify:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Takuto Wada <takuto.wada@gmail.com>
 *   contributors: Okuno Kentaro, Ayumu Sato, Denis Sokolov, yudppp, Daijiro Wachi
 *   homepage: https://github.com/twada/licensify
 *   version: 3.1.0
 * 
 * convert-source-map:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Thorsten Lorenz <thlorenz@gmx.de>
 *   maintainers: thlorenz <thlorenz@gmx.de>
 *   homepage: https://github.com/thlorenz/convert-source-map
 *   version: 1.2.0
 * 
 * core-util-is:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Isaac Z. Schlueter <i@izs.me>
 *   maintainers: isaacs <i@izs.me>
 *   homepage: https://github.com/isaacs/core-util-is#readme
 *   version: 1.0.2
 * 
 * inherits:
 *   license: ISC (http://opensource.org/licenses/ISC)
 *   maintainers: isaacs <i@izs.me>
 *   homepage: https://github.com/isaacs/inherits#readme
 *   version: 2.0.1
 * 
 * isarray:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Julian Gruber <mail@juliangruber.com>
 *   maintainers: juliangruber <julian@juliangruber.com>
 *   homepage: https://github.com/juliangruber/isarray
 *   version: 1.0.0
 * 
 * offset-sourcemap-lines:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Takuto Wada <takuto.wada@gmail.com>
 *   maintainers: twada <takuto.wada@gmail.com>
 *   homepage: https://github.com/twada/offset-sourcemap-lines
 *   version: 0.1.0
 * 
 * osi-licenses:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Meryn Stol <merynstol@gmail.com>
 *   maintainers: meryn <merynstol@gmail.com>
 *   homepage: https://github.com/meryn/osi-licenses
 *   version: 0.1.1
 * 
 * oss-license-name-to-url:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Zeke Sikelianos <zeke@sikelianos.com>
 *   maintainers: zeke <zeke@sikelianos.com>, isaacs <isaacs@npmjs.com>
 *   homepage: https://github.com/npm/oss-license-name-to-url
 *   version: 1.2.1
 * 
 * process-nextick-args:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   maintainers: cwmma <calvin.metcalf@gmail.com>
 *   homepage: https://github.com/calvinmetcalf/process-nextick-args
 *   version: 1.0.6
 * 
 * readable-stream:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   maintainers: isaacs <isaacs@npmjs.com>, tootallnate <nathan@tootallnate.net>, rvagg <rod@vagg.org>, cwmma <calvin.metcalf@gmail.com>
 *   homepage: https://github.com/nodejs/readable-stream#readme
 *   version: 2.0.6
 * 
 * source-map:
 *   license: BSD-3-Clause (http://opensource.org/licenses/BSD-3-Clause)
 *   author: Nick Fitzgerald <nfitzgerald@mozilla.com>
 *   maintainers: mozilla-devtools <mozilla-developer-tools@googlegroups.com>, mozilla <dherman@mozilla.com>, nickfitzgerald <fitzgen@gmail.com>
 *   contributors: Simon Lydell <simon.lydell@gmail.com>, Tobias Koppers <tobias.koppers@googlemail.com>, Stephen Crane <scrane@mozilla.com>, Ryan Seddon <seddon.ryan@gmail.com>, Miles Elam <miles.elam@deem.com>, Mihai Bazon <mihai.bazon@gmail.com>, Michael Ficarra <github.public.email@michael.ficarra.me>, Todd Wolfson <todd@twolfson.com>, Alexander Solovyov <alexander@solovyov.net>, Felix Gnass <fgnass@gmail.com>, Conrad Irwin <conrad.irwin@gmail.com>, usrbincc <usrbincc@yahoo.com>, David Glasser <glasser@davidglasser.net>, Chase Douglas <chase@newrelic.com>, Evan Wallace <evan.exe@gmail.com>, Heather Arthur <fayearthur@gmail.com>, Hugh Kennedy <hughskennedy@gmail.com>, David Glasser <glasser@davidglasser.net>, Duncan Beevers <duncan@dweebd.com>, Jmeas Smith <jellyes2@gmail.com>, Michael Z Goddard <mzgoddard@gmail.com>, azu <azu@users.noreply.github.com>, John Gozde <john@gozde.ca>, Adam Kirkton <akirkton@truefitinnovation.com>, Chris Montgomery <christopher.montgomery@dowjones.com>, J. Ryan Stinnett <jryans@gmail.com>, Jack Herrington <jherrington@walmartlabs.com>, Chris Truter <jeffpalentine@gmail.com>, Daniel Espeset <daniel@danielespeset.com>, Jamie Wong <jamie.lf.wong@gmail.com>, Eddy Bruël <ejpbruel@mozilla.com>, Hawken Rives <hawkrives@gmail.com>, Gilad Peleg <giladp007@gmail.com>, djchie <djchie.dev@gmail.com>, Gary Ye <garysye@gmail.com>, Nicolas Lalevée <nicolas.lalevee@hibnet.org>
 *   homepage: https://github.com/mozilla/source-map
 *   version: 0.5.3
 * 
 * string_decoder:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   maintainers: substack <mail@substack.net>, rvagg <rod@vagg.org>
 *   homepage: https://github.com/rvagg/string_decoder
 *   version: 0.10.31
 * 
 * through2:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Rod Vagg <r@va.gg>
 *   maintainers: rvagg <rod@vagg.org>, bryce <bryce@ravenwall.com>
 *   homepage: https://github.com/rvagg/through2#readme
 *   version: 2.0.1
 * 
 * type-name:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Takuto Wada <takuto.wada@gmail.com>
 *   maintainers: twada <takuto.wada@gmail.com>
 *   contributors: azu, Yosuke Furukawa
 *   homepage: https://github.com/twada/type-name
 *   version: 2.0.0
 * 
 * util-deprecate:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Nathan Rajlich <nathan@tootallnate.net>
 *   maintainers: tootallnate <nathan@tootallnate.net>
 *   homepage: https://github.com/TooTallNate/util-deprecate
 *   version: 1.0.2
 * 
 * xtend:
 *   license: MIT (http://opensource.org/licenses/MIT)
 *   author: Raynos <raynos2@gmail.com>
 *   maintainers: raynos <raynos2@gmail.com>
 *   contributors: Jake Verbaten, Matt Esch
 *   homepage: https://github.com/Raynos/xtend
 *   version: 4.0.1
 * 
 * This header is generated by licensify (https://github.com/twada/licensify)
 */
(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
...(your bundle continues ...)

HOW TO USE

by command-line

$ browserify main.js -p licensify > build/bundle.js 

or programmatically

var browserify = require('browserify');
var licensify = require('licensify');
var fs = require('fs');
var dest = fs.createWriteStream('/path/to/bundle.js');

var b = browserify();
b.add('/path/to/your/file');
b.plugin(licensify);
b.bundle().pipe(dest)

browser field

Since 2.0.0, licensify scans and traverses browser field if exists.

private field

Since 3.0.0, licensify ignores packages which are marked as private in package.json by default.

includePrivate option

if includePrivate option is truthy, licensify includes private packages too.

by command-line

$ $(npm bin)/browserify path/to/your/file.js -p [ licensify --includePrivate ] > build/bundle.js 

or programmatically

var browserify = require('browserify');
var licensify = require('licensify');

var b = browserify();
b.add('/path/to/your/file');
b.plugin(licensify, { includePrivate: true });
b.bundle().pipe(dest)

INSTALL

$ npm install --save-dev licensify

AUTHOR

• Takuto Wada

CONTRIBUTORS

• Okuno Kentaro
• Ayumu Sato
• Denis Sokolov
• yudppp
• Daijiro Wachi
• Adam Prescott
• Hayato Mizuno

SUPPORT POLICY

Node under maintenance is supported.

NOTE: If licensify works in any of the unsupported environments, it is purely coincidental and has no bearing on future compatibility. Use at your own risk.

LICENSE

Licensed under the MIT license.

3.1.3 (2017-04-21)

Bug Fixes

• Ignore invalid pkg (by @pocotan001)

3.1.2 (2016-05-31)

Bug Fixes

• Avoid trailing spaces on lines containing only an asterisk (by @aprescott)

3.1.1 (2016-05-12)

Bug Fixes

• Fix invalid SourceMap mapping error when using babelify

3.1.0 (2016-03-14)

Features

• Support two operators (AND/OR) in SPDX license expression as multiple common licenses (by @watilde)

3.0.1 (2016-03-10)

Bug Fixes

• dealing with licences field without type field

3.0.0 (2016-03-04)

Features

• Ignore private packages by default (by @yudppp)
• includePrivate option to include private packages

Breaking Changes

Since 3.0.0, licensify ignores packages which are marked as private in package.json by default. To include private packages as before, please use includePrivate option. When includePrivate option is truthy, licensify includes private packages.

CLI usage:

$ $(npm bin)/browserify path/to/your/file.js -p [ licensify --includePrivate ] > build/bundle.js 

API usage:

var browserify = require('browserify');
var licensify = require('licensify');

var b = browserify();
b.add('/path/to/your/file');
b.plugin(licensify, { includePrivate: true });
b.bundle().pipe(dest)

2.2.0 (2016-02-01)

Features

• Add opensource.org URL if license name is a valid SPDX expression

2.1.0 (2016-01-16)

Features

• support SourceMap through browserify's --debug option

2.0.1 (2015-09-13)

• add Node 4.0.0 to CI (bebe1b8)

2.0.0 (2015-09-07)

Features

• always scan browser field (6728e47c, closes #5)

Breaking Changes

• scanBrowser option is ignored since this release and treated as scanBrowser=true at all times.

  (6728e47c)

1.5.0 (2015-09-01)

Features

• Add @license tag to the header (by @denis-sokolov)

1.4.0 (2015-08-03)

Features

• add homepage field
• add "generated by" section to provide hint for tools such as uglifyjs (49fc88d9)

1.3.0 (2015-07-27)

Features

• move main module to the top (d44c5e8d)

1.2.0 (2015-07-23)

Features

• add version field (by @ahomu)

1.1.0 (2015-04-05)

Bug Fixes

• stream returned by bundle is readable-only since browserify 9.0.5 (5a26a22a)

Features

• scanBrowser option to scan browser field (by @armorik83)

1.0.0 (2015-02-06)

switch to semver

0.2.0 (2014-12-14)

Features

• licensify:
  • add maintainers and contributors to header (525066e2)

0.1.0 (2014-12-03)

initial release