Blame view
node_modules/eslint/lib/config/config-validator.js
5.05 KB
f7563de62
|
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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
/** * @fileoverview Validates configs. * @author Brandon Mills */ "use strict"; //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ const rules = require("../rules"), Environments = require("./environments"), schemaValidator = require("is-my-json-valid"), util = require("util"); const validators = { rules: Object.create(null) }; //------------------------------------------------------------------------------ // Private //------------------------------------------------------------------------------ /** * Gets a complete options schema for a rule. * @param {string} id The rule's unique name. * @returns {Object} JSON Schema for the rule's options. */ function getRuleOptionsSchema(id) { const rule = rules.get(id), schema = rule && rule.schema || rule && rule.meta && rule.meta.schema; // Given a tuple of schemas, insert warning level at the beginning if (Array.isArray(schema)) { if (schema.length) { return { type: "array", items: schema, minItems: 0, maxItems: schema.length }; } return { type: "array", minItems: 0, maxItems: 0 }; } // Given a full schema, leave it alone return schema || null; } /** * Validates a rule's severity and returns the severity value. Throws an error if the severity is invalid. * @param {options} options The given options for the rule. * @returns {number|string} The rule's severity value */ function validateRuleSeverity(options) { const severity = Array.isArray(options) ? options[0] : options; if (severity !== 0 && severity !== 1 && severity !== 2 && !(typeof severity === "string" && /^(?:off|warn|error)$/i.test(severity))) { throw new Error(`\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '${util.inspect(severity).replace(/'/g, "\"").replace(/ /g, "")}'). `); } return severity; } /** * Validates the non-severity options passed to a rule, based on its schema. * @param {string} id The rule's unique name * @param {array} localOptions The options for the rule, excluding severity * @returns {void} */ function validateRuleSchema(id, localOptions) { const schema = getRuleOptionsSchema(id); if (!validators.rules[id] && schema) { validators.rules[id] = schemaValidator(schema, { verbose: true }); } const validateRule = validators.rules[id]; if (validateRule) { validateRule(localOptions); if (validateRule.errors) { throw new Error(validateRule.errors.map(error => `\tValue "${error.value}" ${error.message}. `).join("")); } } } /** * Validates a rule's options against its schema. * @param {string} id The rule's unique name. * @param {array|number} options The given options for the rule. * @param {string} source The name of the configuration source. * @returns {void} */ function validateRuleOptions(id, options, source) { try { const severity = validateRuleSeverity(options); if (severity !== 0 && !(typeof severity === "string" && severity.toLowerCase() === "off")) { validateRuleSchema(id, Array.isArray(options) ? options.slice(1) : []); } } catch (err) { throw new Error(`${source}: \tConfiguration for rule "${id}" is invalid: ${err.message}`); } } /** * Validates an environment object * @param {Object} environment The environment config object to validate. * @param {string} source The location to report with any errors. * @returns {void} */ function validateEnvironment(environment, source) { // not having an environment is ok if (!environment) { return; } if (Array.isArray(environment)) { throw new Error("Environment must not be an array"); } if (typeof environment === "object") { Object.keys(environment).forEach(env => { if (!Environments.get(env)) { const message = [ source, ": ", "\tEnvironment key \"", env, "\" is unknown " ]; throw new Error(message.join("")); } }); } else { throw new Error("Environment must be an object"); } } /** * Validates an entire config object. * @param {Object} config The config object to validate. * @param {string} source The location to report with any errors. * @returns {void} */ function validate(config, source) { if (typeof config.rules === "object") { Object.keys(config.rules).forEach(id => { validateRuleOptions(id, config.rules[id], source); }); } validateEnvironment(config.env, source); } //------------------------------------------------------------------------------ // Public Interface //------------------------------------------------------------------------------ module.exports = { getRuleOptionsSchema, validate, validateRuleOptions }; |