google_forms/node_modules/eslint/lib/config/rule-validator.js

159 lines
4.9 KiB
JavaScript
Raw Normal View History

2024-08-09 12:04:48 +00:00
/**
* @fileoverview Rule Validator
* @author Nicholas C. Zakas
*/
"use strict";
//-----------------------------------------------------------------------------
// Requirements
//-----------------------------------------------------------------------------
2024-08-21 06:34:30 +00:00
const ajvImport = require("../shared/ajv");
const ajv = ajvImport();
const {
parseRuleId,
getRuleFromConfig,
getRuleOptionsSchema
} = require("./flat-config-helpers");
const ruleReplacements = require("../../conf/replacements.json");
2024-08-09 12:04:48 +00:00
//-----------------------------------------------------------------------------
// Helpers
//-----------------------------------------------------------------------------
/**
2024-08-21 06:34:30 +00:00
* Throws a helpful error when a rule cannot be found.
* @param {Object} ruleId The rule identifier.
* @param {string} ruleId.pluginName The ID of the rule to find.
* @param {string} ruleId.ruleName The ID of the rule to find.
2024-08-09 12:04:48 +00:00
* @param {Object} config The config to search in.
2024-08-21 06:34:30 +00:00
* @throws {TypeError} For missing plugin or rule.
* @returns {void}
2024-08-09 12:04:48 +00:00
*/
2024-08-21 06:34:30 +00:00
function throwRuleNotFoundError({ pluginName, ruleName }, config) {
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
const ruleId = pluginName === "@" ? ruleName : `${pluginName}/${ruleName}`;
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
const errorMessageHeader = `Key "rules": Key "${ruleId}"`;
let errorMessage = `${errorMessageHeader}: Could not find plugin "${pluginName}".`;
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
// if the plugin exists then we need to check if the rule exists
if (config.plugins && config.plugins[pluginName]) {
const replacementRuleName = ruleReplacements.rules[ruleName];
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
if (pluginName === "@" && replacementRuleName) {
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
errorMessage = `${errorMessageHeader}: Rule "${ruleName}" was removed and replaced by "${replacementRuleName}".`;
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
} else {
errorMessage = `${errorMessageHeader}: Could not find "${ruleName}" in plugin "${pluginName}".`;
2024-08-09 12:04:48 +00:00
2024-08-21 06:34:30 +00:00
// otherwise, let's see if we can find the rule name elsewhere
for (const [otherPluginName, otherPlugin] of Object.entries(config.plugins)) {
if (otherPlugin.rules && otherPlugin.rules[ruleName]) {
errorMessage += ` Did you mean "${otherPluginName}/${ruleName}"?`;
break;
}
}
2024-08-09 12:04:48 +00:00
}
2024-08-21 06:34:30 +00:00
// falls through to throw error
2024-08-09 12:04:48 +00:00
}
2024-08-21 06:34:30 +00:00
throw new TypeError(errorMessage);
2024-08-09 12:04:48 +00:00
}
//-----------------------------------------------------------------------------
// Exports
//-----------------------------------------------------------------------------
/**
* Implements validation functionality for the rules portion of a config.
*/
class RuleValidator {
/**
* Creates a new instance.
*/
constructor() {
/**
* A collection of compiled validators for rules that have already
* been validated.
* @type {WeakMap}
*/
this.validators = new WeakMap();
}
/**
* Validates all of the rule configurations in a config against each
* rule's schema.
* @param {Object} config The full config to validate. This object must
* contain both the rules section and the plugins section.
* @returns {void}
* @throws {Error} If a rule's configuration does not match its schema.
*/
validate(config) {
if (!config.rules) {
return;
}
for (const [ruleId, ruleOptions] of Object.entries(config.rules)) {
// check for edge case
if (ruleId === "__proto__") {
continue;
}
/*
* If a rule is disabled, we don't do any validation. This allows
* users to safely set any value to 0 or "off" without worrying
* that it will cause a validation error.
*
* Note: ruleOptions is always an array at this point because
* this validation occurs after FlatConfigArray has merged and
* normalized values.
*/
if (ruleOptions[0] === 0) {
continue;
}
2024-08-21 06:34:30 +00:00
const rule = getRuleFromConfig(ruleId, config);
if (!rule) {
throwRuleNotFoundError(parseRuleId(ruleId), config);
}
2024-08-09 12:04:48 +00:00
// Precompile and cache validator the first time
if (!this.validators.has(rule)) {
const schema = getRuleOptionsSchema(rule);
if (schema) {
this.validators.set(rule, ajv.compile(schema));
}
}
const validateRule = this.validators.get(rule);
if (validateRule) {
validateRule(ruleOptions.slice(1));
if (validateRule.errors) {
throw new Error(`Key "rules": Key "${ruleId}": ${
validateRule.errors.map(
error => `\tValue ${JSON.stringify(error.data)} ${error.message}.\n`
).join("")
}`);
}
}
}
}
}
exports.RuleValidator = RuleValidator;