sindresorhus / spdx-license-list Goto Github PK

View Code? Open in Web Editor NEW

87.0 9.0 16.0 4.14 MB

List of SPDX licenses

License: Creative Commons Zero v1.0 Universal

JavaScript 82.73% TypeScript 17.27%

spdx spdx-licenses javascript json list nodejs

spdx-license-list's Introduction

spdx-license-list

List of SPDX licenses

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

spdx.json contains just license metadata
spdx-full.json includes the license text too
spdx-simple.json only contains the license IDs

Using SPDX License List version 3.23 (2024-02-08)

Install

npm install spdx-license-list

Usage

const spdxLicenseList = require('spdx-license-list');

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

const mitLicense = require('spdx-license-list/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('spdx-license-list/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('spdx-license-list/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.

spdx-license-list's People

Contributors

Stargazers

Watchers

Forkers

kemitchell pombredanne operofi thehaf hanshammel mlinksva mikhus tiagodanin-forks imraazrally ovyerus ddgenome richienb larsgw katyamuland

spdx-license-list's Issues

Thoughts on license-generator (string variable interpolation)?

Currently there exists a package https://github.com/arshad/license-generator which is outdated/does not have all the licenses available I believe.

@sindresorhus I was curious if you experimented at all with interpolation of variable names <name>, <year>, etc. It'd be very convenient for generating packages

I do understand though that NPM, GitHub, and Choose a License/Shields.io look at package.json for license prop - though I think it seems a standard to also include a LICENSE file?

Update to SPDX version 3.6 2019-07-10

Could this package be updated to use the licenses of SPDX version 3.6 2019-07-10?
From the code it would seem that you can regenerate and push the updates.

Switch to the official API in the build script

https://spdx.org/licenses/licenses.json

Currently blocked by them not providing the full license text through their API.

Example usage: https://github.com/shinnn/spdx-license-ids/blob/f3fba84725ceccf9e0bf99e81a09e37bf96659a8/build.js#L13

// @kemitchell

Generate licenses?

Can the license text be used to generate licenses? It seems that the text actually contains not just the full license text but SPDX markup for matching purposes. Is there a parser for this markup that could be fed with user-provided settings?

Dynamically generate the JSON files

The current JSON file is manually created. Would be nice to have a script for this.

How about precomputing two JSON files, one minimal spdx.json with just the current metadata (+ link to the license), and one spdx-full.json that also includes the licenses (which would be the one we use in Node)?

One bi-effect of #1 is that there is now a https://github.com/sindresorhus/spdx-license-list/blob/master/licenses/spdx_licenselist_v1.20.xls with the metadata. So could potentially just parse that one.

@danielhusar Interested?

All instances of `https` are currently output as `http s `

It seems like there's something weird going on with https URLs in the licenseText fields – they all have a space on either side of the s (i.e. http s ://).

tiagodanin earned $10.00 by resolving this issue!

Checkout the Issuehunt explorer to discover more funded issues.

Need some help from other developers? Add your repositories on Issuehunt to raise funds.

FYI: SPDX is Working on Structured-Data License Text Forms

The SPDX working groups have put a lot of effort into translating the license text forms into a machine-readable template format. That work is here:

https://github.com/spdx/license-list-XML

They have not yet blessed the XML repository as "ready" or "official". But progress has been very good. If and when it's ready, you may prefer to consume that source for license texts.

cc @jlovejoy @bradleeedmondson, with a quick note: This is one of a few packages in the Node.js/JavaScript ecosystem that packages up and publishes the license list as a data library. Most of these use scripts to pull down JSON or other files from spdx.org. This package pulls down license texts in addition to list metadata. spdx-license-ids is just license IDs.

node_modules/spdx-license-list/spdx-full.json:54:15: Unterminated string constant (54:15)

appears on the logs