212 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			212 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
| /**
 | |
|  * @fileoverview Validate strings passed to the RegExp constructor
 | |
|  * @author Michael Ficarra
 | |
|  */
 | |
| "use strict";
 | |
| 
 | |
| //------------------------------------------------------------------------------
 | |
| // Requirements
 | |
| //------------------------------------------------------------------------------
 | |
| 
 | |
| const RegExpValidator = require("@eslint-community/regexpp").RegExpValidator;
 | |
| const validator = new RegExpValidator();
 | |
| const validFlags = "dgimsuvy";
 | |
| const undefined1 = void 0;
 | |
| 
 | |
| //------------------------------------------------------------------------------
 | |
| // Rule Definition
 | |
| //------------------------------------------------------------------------------
 | |
| 
 | |
| /** @type {import('../shared/types').Rule} */
 | |
| module.exports = {
 | |
|     meta: {
 | |
|         type: "problem",
 | |
| 
 | |
|         defaultOptions: [{}],
 | |
| 
 | |
|         docs: {
 | |
|             description: "Disallow invalid regular expression strings in `RegExp` constructors",
 | |
|             recommended: true,
 | |
|             url: "https://eslint.org/docs/latest/rules/no-invalid-regexp"
 | |
|         },
 | |
| 
 | |
|         schema: [{
 | |
|             type: "object",
 | |
|             properties: {
 | |
|                 allowConstructorFlags: {
 | |
|                     type: "array",
 | |
|                     items: {
 | |
|                         type: "string"
 | |
|                     }
 | |
|                 }
 | |
|             },
 | |
|             additionalProperties: false
 | |
|         }],
 | |
| 
 | |
|         messages: {
 | |
|             regexMessage: "{{message}}."
 | |
|         }
 | |
|     },
 | |
| 
 | |
|     create(context) {
 | |
|         const [{ allowConstructorFlags }] = context.options;
 | |
|         let allowedFlags = [];
 | |
| 
 | |
|         if (allowConstructorFlags) {
 | |
|             const temp = allowConstructorFlags.join("").replace(new RegExp(`[${validFlags}]`, "gu"), "");
 | |
| 
 | |
|             if (temp) {
 | |
|                 allowedFlags = [...new Set(temp)];
 | |
|             }
 | |
|         }
 | |
| 
 | |
|         /**
 | |
|          * Reports error with the provided message.
 | |
|          * @param {ASTNode} node The node holding the invalid RegExp
 | |
|          * @param {string} message The message to report.
 | |
|          * @returns {void}
 | |
|          */
 | |
|         function report(node, message) {
 | |
|             context.report({
 | |
|                 node,
 | |
|                 messageId: "regexMessage",
 | |
|                 data: { message }
 | |
|             });
 | |
|         }
 | |
| 
 | |
|         /**
 | |
|          * Check if node is a string
 | |
|          * @param {ASTNode} node node to evaluate
 | |
|          * @returns {boolean} True if its a string
 | |
|          * @private
 | |
|          */
 | |
|         function isString(node) {
 | |
|             return node && node.type === "Literal" && typeof node.value === "string";
 | |
|         }
 | |
| 
 | |
|         /**
 | |
|          * Gets flags of a regular expression created by the given `RegExp()` or `new RegExp()` call
 | |
|          * Examples:
 | |
|          *     new RegExp(".")         // => ""
 | |
|          *     new RegExp(".", "gu")   // => "gu"
 | |
|          *     new RegExp(".", flags)  // => null
 | |
|          * @param {ASTNode} node `CallExpression` or `NewExpression` node
 | |
|          * @returns {string|null} flags if they can be determined, `null` otherwise
 | |
|          * @private
 | |
|          */
 | |
|         function getFlags(node) {
 | |
|             if (node.arguments.length < 2) {
 | |
|                 return "";
 | |
|             }
 | |
| 
 | |
|             if (isString(node.arguments[1])) {
 | |
|                 return node.arguments[1].value;
 | |
|             }
 | |
| 
 | |
|             return null;
 | |
|         }
 | |
| 
 | |
|         /**
 | |
|          * Check syntax error in a given pattern.
 | |
|          * @param {string} pattern The RegExp pattern to validate.
 | |
|          * @param {Object} flags The RegExp flags to validate.
 | |
|          * @param {boolean} [flags.unicode] The Unicode flag.
 | |
|          * @param {boolean} [flags.unicodeSets] The UnicodeSets flag.
 | |
|          * @returns {string|null} The syntax error.
 | |
|          */
 | |
|         function validateRegExpPattern(pattern, flags) {
 | |
|             try {
 | |
|                 validator.validatePattern(pattern, undefined1, undefined1, flags);
 | |
|                 return null;
 | |
|             } catch (err) {
 | |
|                 return err.message;
 | |
|             }
 | |
|         }
 | |
| 
 | |
|         /**
 | |
|          * Check syntax error in a given flags.
 | |
|          * @param {string|null} flags The RegExp flags to validate.
 | |
|          * @param {string|null} flagsToCheck The RegExp invalid flags.
 | |
|          * @param {string} allFlags all valid and allowed flags.
 | |
|          * @returns {string|null} The syntax error.
 | |
|          */
 | |
|         function validateRegExpFlags(flags, flagsToCheck, allFlags) {
 | |
|             const duplicateFlags = [];
 | |
| 
 | |
|             if (typeof flagsToCheck === "string") {
 | |
|                 for (const flag of flagsToCheck) {
 | |
|                     if (allFlags.includes(flag)) {
 | |
|                         duplicateFlags.push(flag);
 | |
|                     }
 | |
|                 }
 | |
|             }
 | |
| 
 | |
|             /*
 | |
|              * `regexpp` checks the combination of `u` and `v` flags when parsing `Pattern` according to `ecma262`,
 | |
|              * but this rule may check only the flag when the pattern is unidentifiable, so check it here.
 | |
|              * https://tc39.es/ecma262/multipage/text-processing.html#sec-parsepattern
 | |
|              */
 | |
|             if (flags && flags.includes("u") && flags.includes("v")) {
 | |
|                 return "Regex 'u' and 'v' flags cannot be used together";
 | |
|             }
 | |
| 
 | |
|             if (duplicateFlags.length > 0) {
 | |
|                 return `Duplicate flags ('${duplicateFlags.join("")}') supplied to RegExp constructor`;
 | |
|             }
 | |
| 
 | |
|             if (!flagsToCheck) {
 | |
|                 return null;
 | |
|             }
 | |
| 
 | |
|             return `Invalid flags supplied to RegExp constructor '${flagsToCheck}'`;
 | |
|         }
 | |
| 
 | |
|         return {
 | |
|             "CallExpression, NewExpression"(node) {
 | |
|                 if (node.callee.type !== "Identifier" || node.callee.name !== "RegExp") {
 | |
|                     return;
 | |
|                 }
 | |
| 
 | |
|                 const flags = getFlags(node);
 | |
|                 let flagsToCheck = flags;
 | |
|                 const allFlags = allowedFlags.length > 0 ? validFlags.split("").concat(allowedFlags) : validFlags.split("");
 | |
| 
 | |
|                 if (flags) {
 | |
|                     allFlags.forEach(flag => {
 | |
|                         flagsToCheck = flagsToCheck.replace(flag, "");
 | |
|                     });
 | |
|                 }
 | |
| 
 | |
|                 let message = validateRegExpFlags(flags, flagsToCheck, allFlags);
 | |
| 
 | |
|                 if (message) {
 | |
|                     report(node, message);
 | |
|                     return;
 | |
|                 }
 | |
| 
 | |
|                 if (!isString(node.arguments[0])) {
 | |
|                     return;
 | |
|                 }
 | |
| 
 | |
|                 const pattern = node.arguments[0].value;
 | |
| 
 | |
|                 message = (
 | |
| 
 | |
|                     // If flags are unknown, report the regex only if its pattern is invalid both with and without the "u" flag
 | |
|                     flags === null
 | |
|                         ? (
 | |
|                             validateRegExpPattern(pattern, { unicode: true, unicodeSets: false }) &&
 | |
|                             validateRegExpPattern(pattern, { unicode: false, unicodeSets: true }) &&
 | |
|                             validateRegExpPattern(pattern, { unicode: false, unicodeSets: false })
 | |
|                         )
 | |
|                         : validateRegExpPattern(pattern, { unicode: flags.includes("u"), unicodeSets: flags.includes("v") })
 | |
|                 );
 | |
| 
 | |
|                 if (message) {
 | |
|                     report(node, message);
 | |
|                 }
 | |
|             }
 | |
|         };
 | |
|     }
 | |
| };
 |