Socket
Socket
Sign inDemoInstall

@ovyerus/licenses

Package Overview
Dependencies
0
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @ovyerus/licenses

List of SPDX licenses with predictable placeholders


Version published
Weekly downloads
431
decreased by-21.78%
Maintainers
1
Install size
7.14 MB
Created
Weekly downloads
 

Readme

Source

licenses Build Status

List of SPDX licenses with predictable placeholder strings for copyright info.

This is a fork of spdx-license-list with added placeholders in the copyright strings (of most of the licenses) to make it easy for machines to create licenses with user-given info.

Some licenses are skipped due to being overly specific for that particular product or company, however most generic, OSI-approved licenses should have them just fine.

(If you want to add support for a license that hasn't received placeholders yet, feel free to submit a PR 😃)

The lists of licenses are just JSON files and can be used anywhere.

Using SPDX License List version 3.8 (2020-02-09)

The placeholders in the text are in the format of <placeholder name>, so for example, Copyright (c) 2002 John Doe would become Copyright (c) <year> <author>

Install

$ npm install @ovyerus/licenses

Usage

const spdxLicenseList = require('@ovyerus/licenses');

console.log(spdxLicenseList.MIT);
/*
{
	name: 'MIT License',
	url: 'http://www.opensource.org/licenses/MIT',
	osiApproved: true
}
*/
const mitLicense = require('@ovyerus/licenses/licenses/MIT');

console.log(mitLicense.licenseText);
//=> 'MIT License\r\n\r\nCopyright (c) <year> <copyright holders> …'

You can also get a version with the licence text included:

const spdxLicenseList = require('@ovyerus/licenses/full');

console.log(spdxLicenseList.MIT);
/*
{
	name: 'MIT License',
	url: 'http://www.opensource.org/licenses/MIT',
	osiApproved: true,
	licenseText: '…'
}
*/

Or just the license IDs as a Set:

const spdxLicenseList = require('@ovyerus/licenses/simple');

console.log(spdxLicenseList);
//=> Set {'Glide', 'Abstyles', …}

API

spdxLicenseList

Type: Object

The licenses are indexed by their identifier and contains a name property with the full name of the license, url with the URL to the license, and osiApproved boolean for whether the license is OSI Approved.

Keywords

FAQs

Last updated on 23 Feb 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc