summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/init-package-json/node_modules/validate-npm-package-license/README.md
blob: 904f74b9d3b810909555d3e8cf549107bc4b5f05 (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
npm-validate-package-license
============================

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

*This package is not endorsed or approved by npm. It is part of a proposal to add license field validation to the npm command-line interface.*

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

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

valid('Apache-2.0'); // => validResult
valid('GPL-3.0 OR BSD-2-Clause'); // => validResult

var invalidResult = {
  validForOldPackages: false,
  validForNewPackages: false,
  warnings: [
    'license should be a valid SPDX license expression',
	'license is similar to the valid expression "Apache-2.0"'
  ]
};

valid('Apache 2.0'); // => invalidResult
```