beginpm-license

beginpm-license

Add a license file to your module.

This is meant to be used with beginpm, but you can probably use it anywhere!

use

It's not very complicated:

const license = require('beginpm-license')
const cwd = '/path/to/module'
const options = {
	license: 'MIT',
	// If the license requires a name and date,
	// these properties are required.
	date: '2017',
	holder: 'Tobias Davis',
	// Optional field
	filename: 'LICENSE.txt'
}
license({ cwd }, options)
	.then(() => {
		// The file is written
		// /path/to/module/LICENSE.txt
	})

options

license (string, required)

The identifier of the license. Supported licenses are:

• MIT
• VOL

Feel free to add more license files in a pull request to master!

If the property does not match a known license, the promise will reject with the error UNRECOGNIZED_LICENSE.

date (string, may be required)

If the license requires a date, this property will be required. It must be a pre-formatted string.

If the property is required but not provided, the promise will reject with the error DATE_PROPERTY_REQUIRED.

holder (string, may be required)

If the license requires a name, this property will be required. It must be a pre-formatted string.

If the property is required but not provided, the promise will reject with the error HOLDER_PROPERTY_REQUIRED.

filename (string, default LICENSE.txt)

You may specify a filename, for example LICENSE.txt.

license

This module beginpm-license, and all code and documentation, is published under the Very Open License