prefer-string-replace-all: Preserve escape (#2667)

Author: fisker

.github/workflows/main.yml

@@ -54,7 +54,7 @@ jobs:
         env:
           AVA_FORCE_CI: not-ci
       - run: git diff --exit-code
-      - uses: codecov/codecov-action@v4
+      - uses: codecov/codecov-action@v5
         with:
           fail_ci_if_error: true
           disable_search: true

rules/prefer-string-replace-all.js

@@ -1,6 +1,5 @@
 import {getStaticValue} from '@eslint-community/eslint-utils';
 import regjsparser from 'regjsparser';
-import escapeString from './utils/escape-string.js';
 import {isRegexLiteral, isNewExpression, isMethodCall} from './ast/index.js';
 
 const {parse: parseRegExp} = regjsparser;
@@ -11,6 +10,8 @@ const messages = {
 	[MESSAGE_ID_USE_STRING]: 'This pattern can be replaced with {{replacement}}.',
 };
 
+const QUOTE = '\'';
+
 function getPatternReplacement(node) {
 	if (!isRegexLiteral(node)) {
 		return;
@@ -39,10 +40,38 @@ function getPatternReplacement(node) {
 		return;
 	}
 
-	// TODO: Preserve escape
-	const string = String.fromCodePoint(...parts.map(part => part.codePoint));
+	return QUOTE
+		+ parts.map(part => {
+			const {kind, codePoint, raw} = part;
+
+			if (kind === 'controlLetter') {
+				if (codePoint === 13) {
+					return String.raw`\r`;
+				}
+
+				if (codePoint === 10) {
+					return String.raw`\n`;
+				}
+
+				if (codePoint === 9) {
+					return String.raw`\t`;
+				}
+
+				return `\\u{${codePoint.toString(16)}}`;
+			}
+
+			let character = raw;
+			if (kind === 'identifier') {
+				character = character.slice(1);
+			}
+
+			if (character === QUOTE || character === '\\') {
+				return `\\${character}`;
+			}
 
-	return escapeString(string);
+			return character;
+		}).join('')
+		+ QUOTE;
 }
 
 const isRegExpWithGlobalFlag = (node, scope) => {

test/prefer-string-replace-all.js

@@ -78,6 +78,8 @@ test.snapshot({
 		String.raw`foo.replace(/\u{61}/g, bar)`,
 		String.raw`foo.replace(/\u{61}/gu, bar)`,
 		String.raw`foo.replace(/\u{61}/gv, bar)`,
+		String.raw`str.replace(/\u200B/g, '')`,
+		String.raw`str.replace(/\x20/g, '')`,
 		'foo.replace(/]/g, "bar")',
 		// Extra flag
 		'foo.replace(/a/gi, bar)',
@@ -94,7 +96,12 @@ test.snapshot({
 		'foo.replace(/a{1}/g, _)',
 		String.raw`foo.replace(/\u0022/g, _)`,
 		String.raw`foo.replace(/\u0027/g, _)`,
-		String.raw`foo.replace(/\cM\cj/g, _)`,
+
+		// `\r\n\t`
+		String.raw`foo.replace(/\cM\cj\cI/g, _)`,
+		String.raw`foo.replace(/\x0d\x0a\x09/g, _)`,
+		String.raw`foo.replace(/\u000d\u000a\u0009/g, _)`,
+
 		String.raw`foo.replace(/\x22/g, _)`,
 		String.raw`foo.replace(/\x27/g, _)`,
 		String.raw`foo.replace(/\uD83D\ude00/g, _)`,