summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/validate-npm-package-license/index.js
blob: adf58d6751bf5e462abeb9feb6fd520eaad9fcdd (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
62
63
64
65
66
67
68
69
70
71
72
73
74
var spdx = require('spdx');
var correct = require('spdx-correct');

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

var genericWarning = (
  'license should be ' +
  'a valid SPDX license expression without "LicenseRef", ' +
  '"UNLICENSED", or ' +
  '"SEE LICENSE IN <filename>"'
);

var fileReferenceRE = /^SEE LICEN[CS]E IN (.+)$/;

function startsWith(prefix, string) {
  return string.slice(0, prefix.length) === prefix;
}

function usesLicenseRef(ast) {
  if (ast.hasOwnProperty('license')) {
    var license = ast.license;
    return (
      startsWith('LicenseRef', license) ||
      startsWith('DocumentRef', license)
    );
  } else {
    return (
      usesLicenseRef(ast.left) ||
      usesLicenseRef(ast.right)
    );
  }
}

module.exports = function(argument) {
  var ast;

  try {
    ast = spdx.parse(argument);
  } catch (e) {
    if (
      argument === 'UNLICENSED' ||
      argument === 'UNLICENCED' ||
      fileReferenceRE.test(argument)
    ) {
      return validResult;
    } else {
      var result = {
        validForOldPackages: false,
        validForNewPackages: false,
        warnings: [genericWarning]
      };
      var corrected = correct(argument);
      if (corrected) {
        result.warnings.push(
          'license is similar to the valid expression "' + corrected + '"'
        );
      }
      return result;
    }
  }

  if (usesLicenseRef(ast)) {
    return {
      validForNewPackages: false,
      validForOldPackages: false,
      warnings: [genericWarning]
    };
  } else {
    return validResult;
  }
};