summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/validate-npm-package-license/README.md
blob: 2c51c8e640da8a31720b0e4342ef6c7c39e6fdf3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
validate-npm-package-license
============================

Give me a string and I'll tell you if it's a valid npm package license string.

<!-- js var valid = require('./'); -->

```js
var noWarnings = {
  validForNewPackages: true,
  validForOldPackages: true
};

// SPDX license identifier for common open-source licenses
valid('MIT'); // => noWarnings
valid('BSD-2-Clause'); // => noWarnings
valid('Apache-2.0'); // => noWarnings
valid('ISC'); // => noWarnings

// Simple SPDX license expression for dual licensing
valid('(GPL-3.0 OR BSD-2-Clause)'); // => noWarnings

// Refer to a non-standard license found in the package
valid('SEE LICENSE IN LICENSE.txt'); // => noWarnings
valid('SEE LICENSE IN license.md'); // => noWarnings

// No license
valid('UNLICENSED'); // => noWarnings
valid('UNLICENCED'); // => noWarnings

var warningsWithSuggestion = {
  validForOldPackages: false,
  validForNewPackages: false,
  warnings: [
    'license should be ' +
    'a valid SPDX license expression without "LicenseRef", ' +
    '"UNLICENSED", or ' +
    '"SEE LICENSE IN <filename>"',
    'license is similar to the valid expression "Apache-2.0"'
  ]
};

// Almost a valid SPDX license identifier
valid('Apache 2.0'); // => warningsWithSuggestion

var warningAboutLicenseRef = {
  validForOldPackages: false,
  validForNewPackages: false,
  warnings: [
    'license should be ' +
    'a valid SPDX license expression without "LicenseRef", ' +
    '"UNLICENSED", or ' +
    '"SEE LICENSE IN <filename>"',
  ]
};

// LicenseRef-* identifiers are valid SPDX expressions,
// but not valid in package.json
valid('LicenseRef-Made-Up'); // => warningAboutLicenseRef
valid('(MIT OR LicenseRef-Made-Up)'); // => warningAboutLicenseRef
```