all files / src/rules/ valid-values-license.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
 
 
1×
1×
1×
1×
1×
1×
 
 
 
 
 
 
 
 
 
1×
3×
1×
 
 
2×
 
 
1×
1×
 
'use strict';
 
const LintIssue = require('./../LintIssue');
const isValidValue = require('./../validators/valid-values').isValidValue;
const lintId = 'valid-values-license';
const nodeName = 'license';
const message = 'Invalid value for license';
const ruleType = 'valid-values';
 
/**
 * Lints package.json file to check for valid values in the license field
 *
 * @param  {Object}   packageJsonData   Valid package.json object
 * @param  {String}   lintType          'error' or 'warning'
 * @param  {Array}    validValues       An array of valid values
 * @return {Object|Boolean}             LintIssue object if invalid. True if valid
 */
const lint = function(packageJsonData, lintType, validValues) {
  if (!isValidValue(packageJsonData, nodeName, validValues)) {
    return new LintIssue(lintId, lintType, nodeName, message);
  }
 
  return true;
};
 
module.exports.lint = lint;
module.exports.ruleType = ruleType;