123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179 |
- /**
- * @fileoverview Validate strings passed to the RegExp constructor
- * @author Michael Ficarra
- */
- "use strict";
- //------------------------------------------------------------------------------
- // Requirements
- //------------------------------------------------------------------------------
- const RegExpValidator = require("regexpp").RegExpValidator;
- const validator = new RegExpValidator();
- const validFlags = /[dgimsuy]/gu;
- const undefined1 = void 0;
- //------------------------------------------------------------------------------
- // Rule Definition
- //------------------------------------------------------------------------------
- /** @type {import('../shared/types').Rule} */
- module.exports = {
- meta: {
- type: "problem",
- docs: {
- description: "Disallow invalid regular expression strings in `RegExp` constructors",
- recommended: true,
- url: "https://eslint.org/docs/rules/no-invalid-regexp"
- },
- schema: [{
- type: "object",
- properties: {
- allowConstructorFlags: {
- type: "array",
- items: {
- type: "string"
- }
- }
- },
- additionalProperties: false
- }],
- messages: {
- regexMessage: "{{message}}."
- }
- },
- create(context) {
- const options = context.options[0];
- let allowedFlags = null;
- if (options && options.allowConstructorFlags) {
- const temp = options.allowConstructorFlags.join("").replace(validFlags, "");
- if (temp) {
- allowedFlags = new RegExp(`[${temp}]`, "giu");
- }
- }
- /**
- * 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 {boolean} uFlag The Unicode flag.
- * @returns {string|null} The syntax error.
- */
- function validateRegExpPattern(pattern, uFlag) {
- try {
- validator.validatePattern(pattern, undefined1, undefined1, uFlag);
- return null;
- } catch (err) {
- return err.message;
- }
- }
- /**
- * Check syntax error in a given flags.
- * @param {string|null} flags The RegExp flags to validate.
- * @returns {string|null} The syntax error.
- */
- function validateRegExpFlags(flags) {
- if (!flags) {
- return null;
- }
- try {
- validator.validateFlags(flags);
- return null;
- } catch {
- return `Invalid flags supplied to RegExp constructor '${flags}'`;
- }
- }
- return {
- "CallExpression, NewExpression"(node) {
- if (node.callee.type !== "Identifier" || node.callee.name !== "RegExp") {
- return;
- }
- let flags = getFlags(node);
- if (flags && allowedFlags) {
- flags = flags.replace(allowedFlags, "");
- }
- let message = validateRegExpFlags(flags);
- 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, true) && validateRegExpPattern(pattern, false)
- : validateRegExpPattern(pattern, flags.includes("u"))
- );
- if (message) {
- report(node, message);
- }
- }
- };
- }
- };
|