all files / src/validators/ dependency-audit.js

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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
 
1×
1×
 
 
 
 
 
 
 
 
1×
9×
3×
 
 
6×
6×
3×
 
 
 
3×
 
 
 
 
 
 
 
 
 
1×
10×
3×
 
 
7×
12×
7×
 
7×
4×
 
 
 
 
3×
 
 
 
 
 
 
 
 
1×
28×
3×
 
 
25×
85×
 
85×
82×
82×
82×
82×
 
 
82×
21×
 
 
 
 
4×
 
 
 
 
 
 
 
 
 
1×
15×
5×
 
 
10×
10×
 
10×
14×
 
14×
6×
 
 
 
10×
 
 
1×
1×
1×
1×
 
"use strict";
 
const inArray = require("in-array");
const semver = require("semver");
 
/**
 * Determines whether or not the package has a given dependency
 * @param  {object} packageJsonData         Valid JSON
 * @param  {string} nodeName                Name of a node in the package.json file
 * @param  {string} depsToCheckFor  An array of packages to check for
 * @return {boolean}                        True if the package has a dependency. False if it is not or the node is missing.
 */
const hasDependency = function(packageJsonData, nodeName, depsToCheckFor) {
  if (!packageJsonData.hasOwnProperty(nodeName)) {
    return false;
  }
 
  for (const dependencyName in packageJsonData[nodeName]) {
    if (inArray(depsToCheckFor, dependencyName)) {
      return true;
    }
  }
 
  return false;
};
 
/**
 * Determines whether or not the package has a pre-release version of a given dependency
 * @param  {object} packageJsonData         Valid JSON
 * @param  {string} nodeName                Name of a node in the package.json file
 * @param  {string} depsToCheckFor          An array of packages to check for
 * @return {boolean}                        True if the package has a pre-release version of a dependency. False if it is not or the node is missing.
 */
const hasDepPrereleaseVers = function(packageJsonData, nodeName, depsToCheckFor) {
  if (!packageJsonData.hasOwnProperty(nodeName)) {
    return false;
  }
 
  for (const dependencyName in packageJsonData[nodeName]) {
    if (inArray(depsToCheckFor, dependencyName)) {
      const dependencyVersion = packageJsonData[nodeName][dependencyName];
 
      if (dependencyVersion.includes("-beta") || dependencyVersion.includes("-rc")) {
        return true;
      }
    }
  }
 
  return false;
};
 
/**
 * Determines whether or not the package has a dependency with a major version of 0
 * @param  {object} packageJsonData         Valid JSON
 * @param  {string} nodeName                Name of a node in the package.json file
 * @return {boolean}                        True if the package has a dependency with version 0. False if it does not or the node is missing.
 */
const hasDepVersZero = function(packageJsonData, nodeName) {
  if (!packageJsonData.hasOwnProperty(nodeName)) {
    return false;
  }
 
  for (const dependencyName in packageJsonData[nodeName]) {
    const dependencyVersRange = packageJsonData[nodeName][dependencyName];
 
    if (semver.validRange(dependencyVersRange)) {
      const startIndex = 0;
      const length = 1;
      const dependencyVersion = dependencyVersRange.replace(/[\D]+/g, "");
      const dependencyMjrVersion = dependencyVersion.substr(startIndex, length);
 
      // if first char is 0 then major version is 0
      if (dependencyMjrVersion === "0") {
        return true;
      }
    }
  }
 
  return false;
};
 
/**
 * Determines whether or not all dependency version ranges match expected range
 * @param  {object} packageJsonData         Valid JSON
 * @param  {string} nodeName                Name of a node in the package.json file
 * @param  {string} rangeSpecifier          A version range specifier
 * @return {boolean}                        False if the package has an invalid range. True if it is not or the node is missing.
 */
const areVersRangesValid = function(packageJsonData, nodeName, rangeSpecifier) {
  if (!packageJsonData.hasOwnProperty(nodeName)) {
    return true;
  }
 
  const firstCharOfStr = 0;
  let rangesValid = true;
 
  for (const dependencyName in packageJsonData[nodeName]) {
    const dependencyVersion = packageJsonData[nodeName][dependencyName];
 
    if (!dependencyVersion.startsWith(rangeSpecifier, firstCharOfStr)) {
      rangesValid = false;
    }
  }
 
  return rangesValid;
};
 
module.exports.hasDependency = hasDependency;
module.exports.hasDepPrereleaseVers = hasDepPrereleaseVers;
module.exports.hasDepVersZero = hasDepVersZero;
module.exports.areVersRangesValid = areVersRangesValid;