Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
feat: Suggestions support for prefer-regex-literals (#15077)
* New: Autofix support to prefer-regex-literals

Fixes #15029

* Use canTokensBeAdjacent

* Fix for NULL

* Switch to validatePattern and validateFlags

* Fix for unicode

* Apply a few suggestions from code review

* Fix: Double Escaping?

* Tests and fixes for no-unicode regexp

* New: Drop usage of getStaticValue

* Fix: Remove whitespace changes, fix jsdoc type, and convert to suggestion for unexpectedRegExp

* New: More test cases for .

* Remove meta.docs.suggestion

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* Fix linting

* Don't fix NULL

* Remove redundant wrapping suggestions for now

* String.raw can have problematic chars

* Remove fixable

* Fix messed up char increase

* Apply suggestion from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* chore: use characterNode.raw instead of characterNode.value

* chore: do a bit of simplification of onCharacterEnter

* Apply suggestions from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* chore: more changes following code review

* chore: Use reliable way of testing if spacing needed

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* diff msg for suggestion than main warning

* chore: stricter testing

* Apply suggestions from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
  • Loading branch information
Yash-Singh1 and mdjermanovic committed Dec 17, 2021
1 parent 314c84c commit 94e77a6
Show file tree
Hide file tree
Showing 2 changed files with 2,475 additions and 40 deletions.
218 changes: 217 additions & 1 deletion lib/rules/prefer-regex-literals.js
Expand Up @@ -11,11 +11,15 @@

const astUtils = require("./utils/ast-utils");
const { CALL, CONSTRUCT, ReferenceTracker, findVariable } = require("eslint-utils");
const { RegExpValidator, visitRegExpAST, RegExpParser } = require("regexpp");
const { canTokensBeAdjacent } = require("./utils/ast-utils");

//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------

const REGEXPP_LATEST_ECMA_VERSION = 2022;

/**
* Determines whether the given node is a string literal.
* @param {ASTNode} node Node to check.
Expand Down Expand Up @@ -43,6 +47,71 @@ function isStaticTemplateLiteral(node) {
return node.type === "TemplateLiteral" && node.expressions.length === 0;
}

const validPrecedingTokens = [
"(",
";",
"[",
",",
"=",
"+",
"*",
"-",
"?",
"~",
"%",
"**",
"!",
"typeof",
"instanceof",
"&&",
"||",
"??",
"return",
"...",
"delete",
"void",
"in",
"<",
">",
"<=",
">=",
"==",
"===",
"!=",
"!==",
"<<",
">>",
">>>",
"&",
"|",
"^",
":",
"{",
"=>",
"*=",
"<<=",
">>=",
">>>=",
"^=",
"|=",
"&=",
"??=",
"||=",
"&&=",
"**=",
"+=",
"-=",
"/=",
"%=",
"/",
"do",
"break",
"continue",
"debugger",
"case",
"throw"
];


//------------------------------------------------------------------------------
// Rule Definition
Expand All @@ -59,6 +128,8 @@ module.exports = {
url: "https://eslint.org/docs/rules/prefer-regex-literals"
},

hasSuggestions: true,

schema: [
{
type: "object",
Expand All @@ -74,13 +145,15 @@ module.exports = {

messages: {
unexpectedRegExp: "Use a regular expression literal instead of the 'RegExp' constructor.",
replaceWithLiteral: "Replace with an equivalent regular expression literal.",
unexpectedRedundantRegExp: "Regular expression literal is unnecessarily wrapped within a 'RegExp' constructor.",
unexpectedRedundantRegExpWithFlags: "Use regular expression literal with flags instead of the 'RegExp' constructor."
}
},

create(context) {
const [{ disallowRedundantWrapping = false } = {}] = context.options;
const sourceCode = context.getSourceCode();

/**
* Determines whether the given identifier node is a reference to a global variable.
Expand All @@ -107,6 +180,27 @@ module.exports = {
isStaticTemplateLiteral(node.quasi);
}

/**
* Gets the value of a string
* @param {ASTNode} node The node to get the string of.
* @returns {string|null} The value of the node.
*/
function getStringValue(node) {
if (isStringLiteral(node)) {
return node.value;
}

if (isStaticTemplateLiteral(node)) {
return node.quasis[0].value.cooked;
}

if (isStringRawTaggedStaticTemplateLiteral(node)) {
return node.quasi.quasis[0].value.raw;
}

return null;
}

/**
* Determines whether the given node is considered to be a static string by the logic of this rule.
* @param {ASTNode} node Node to check.
Expand Down Expand Up @@ -152,6 +246,53 @@ module.exports = {
return false;
}

/**
* Returns a ecmaVersion compatible for regexpp.
* @param {any} ecmaVersion The ecmaVersion to convert.
* @returns {import("regexpp/ecma-versions").EcmaVersion} The resulting ecmaVersion compatible for regexpp.
*/
function getRegexppEcmaVersion(ecmaVersion) {
if (typeof ecmaVersion !== "number" || ecmaVersion <= 5) {
return 5;
}
return Math.min(ecmaVersion + 2009, REGEXPP_LATEST_ECMA_VERSION);
}

/**
* Makes a character escaped or else returns null.
* @param {string} character The character to escape.
* @returns {string} The resulting escaped character.
*/
function resolveEscapes(character) {
switch (character) {
case "\n":
case "\\\n":
return "\\n";

case "\r":
case "\\\r":
return "\\r";

case "\t":
case "\\\t":
return "\\t";

case "\v":
case "\\\v":
return "\\v";

case "\f":
case "\\\f":
return "\\f";

case "/":
return "\\/";

default:
return null;
}
}

return {
Program() {
const scope = context.getScope();
Expand All @@ -171,7 +312,82 @@ module.exports = {
context.report({ node, messageId: "unexpectedRedundantRegExp" });
}
} else if (hasOnlyStaticStringArguments(node)) {
context.report({ node, messageId: "unexpectedRegExp" });
let regexContent = getStringValue(node.arguments[0]);
let noFix = false;
let flags;

if (node.arguments[1]) {
flags = getStringValue(node.arguments[1]);
}

const regexppEcmaVersion = getRegexppEcmaVersion(context.parserOptions.ecmaVersion);
const RegExpValidatorInstance = new RegExpValidator({ ecmaVersion: regexppEcmaVersion });

try {
RegExpValidatorInstance.validatePattern(regexContent, 0, regexContent.length, flags ? flags.includes("u") : false);
if (flags) {
RegExpValidatorInstance.validateFlags(flags);
}
} catch {
noFix = true;
}

const tokenBefore = sourceCode.getTokenBefore(node);

if (tokenBefore && !validPrecedingTokens.includes(tokenBefore.value)) {
noFix = true;
}

if (!/^[-a-zA-Z0-9\\[\](){} \t\r\n\v\f!@#$%^&*+^_=/~`.><?,'"|:;]*$/u.test(regexContent)) {
noFix = true;
}

if (sourceCode.getCommentsInside(node).length > 0) {
noFix = true;
}

if (regexContent && !noFix) {
let charIncrease = 0;

const ast = new RegExpParser({ ecmaVersion: regexppEcmaVersion }).parsePattern(regexContent, 0, regexContent.length, flags ? flags.includes("u") : false);

visitRegExpAST(ast, {
onCharacterEnter(characterNode) {
const escaped = resolveEscapes(characterNode.raw);

if (escaped) {
regexContent =
regexContent.slice(0, characterNode.start + charIncrease) +
escaped +
regexContent.slice(characterNode.end + charIncrease);

if (characterNode.raw.length === 1) {
charIncrease += 1;
}
}
}
});
}

const newRegExpValue = `/${regexContent || "(?:)"}/${flags || ""}`;

context.report({
node,
messageId: "unexpectedRegExp",
suggest: noFix ? [] : [{
messageId: "replaceWithLiteral",
fix(fixer) {
const tokenAfter = sourceCode.getTokenAfter(node);

return fixer.replaceText(
node,
(tokenBefore && !canTokensBeAdjacent(tokenBefore, newRegExpValue) && tokenBefore.range[1] === node.range[0] ? " " : "") +
newRegExpValue +
(tokenAfter && !canTokensBeAdjacent(newRegExpValue, tokenAfter) && node.range[1] === tokenAfter.range[0] ? " " : "")
);
}
}]
});
}
}
}
Expand Down

0 comments on commit 94e77a6

Please sign in to comment.