feature: @putout/plugin-regexp: remove-useless-escape: add

coderaiser · coderaiser · commit 6df56d676873 · 2025-12-07T14:49:21.000+02:00
diff --git a/packages/plugin-regexp/README.md b/packages/plugin-regexp/README.md
@@ -27,6 +27,7 @@ npm i @putout/plugin-regexp -D
 - ✅ [optimize](#optimize);
 - ✅ [remove-useless-group](#remove-useless-group);
 - ✅ [remove-useless-regexp](#remove-useless-regexp);
+- ✅ [remove-useless-escape](#remove-useless-escape);
 - ✅ [remove-duplicates-from-character-class](#remove-duplicates-from-character-class);
 
 ## Config
@@ -43,6 +44,7 @@ npm i @putout/plugin-regexp -D
         "regexp/convert-to-string": "on",
         "regexp/convert-replace-to-replace-all": "on",
         "regexp/remove-useless-group": "on",
+        "regexp/remove-useless-escape": "on",
         "regexp/remove-useless-regexp": "on",
         "regexp/remove-duplicates-from-character-class": "on"
     }
@@ -216,6 +218,29 @@ Simplify code according to [string-replace-all](https://github.com/tc39/proposal
 /hello/.test(str);
 ```
 
+## remove-useless-escape
+
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/af9d1c774c3691aface974406717b32a/e9fc8a985e0195ecc27d70c748e5d4497be91265).
+
+### ❌ Example of incorrect code
+
+```js
+const cleanText = code.replaceAll(/[,;\(\)]/g, '');
+```
+
+### ✅ Example of correct code
+
+```js
+const cleanText = code.replaceAll(/[,;()]/g, '');
+```
+
+### Comparison
+
+Linter | Rule | Fix
+--------|-------|------------|
+🐊 **Putout**| [`regexp/remove-useless-escape`](https://github.com/coderaiser/putout/tree/master/packages/plugin-regexp/#remove-useless-escape)| ✅
+⏣ **ESLint** | [`no-useless-escape`](https://eslint.org/docs/rules/no-useless-escape) | ❌
+
 ## remove-useless-regexp
 
 ### ❌ Example of incorrect code
diff --git a/packages/plugin-regexp/eslint.config.js b/packages/plugin-regexp/eslint.config.js
@@ -4,7 +4,7 @@ import {defineConfig} from 'eslint/config';
 export default defineConfig([
     safeAlign, {
         rules: {
-            'no-useless-return': 'off',
+            'no-useless-escape': 'off',
         },
     },
 ]);
diff --git a/packages/plugin-regexp/lib/index.js b/packages/plugin-regexp/lib/index.js
@@ -1,3 +1,4 @@
+import * as removeUselessEscape from './remove-useless-escape/index.js';
 import * as removeDuplicatesFromCharacterClass from './remove-duplicates-from-character-class/index.js';
 import * as applyCharacterClass from './apply-character-class/index.js';
 import * as applyGlobalRegexpToReplaceAll from './apply-global-regexp-to-replace-all/index.js';
@@ -22,4 +23,5 @@ export const rules = {
     'apply-global-regexp-to-replace-all': applyGlobalRegexpToReplaceAll,
     'apply-character-class': applyCharacterClass,
     'remove-duplicates-from-character-class': removeDuplicatesFromCharacterClass,
+    'remove-useless-escape': removeUselessEscape,
 };
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/colon-fix.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/colon-fix.js
@@ -0,0 +1 @@
+/^\w+:/;
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/colon.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/colon.js
@@ -0,0 +1 @@
+/^\w+\:/
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/coma-fix.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/coma-fix.js
@@ -0,0 +1 @@
+const badMiddle = /\},\n(s+)?\{/;
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/coma.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/coma.js
@@ -0,0 +1 @@
+const badMiddle = /\}\,\n(s+)?\{/;
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/need-escape.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/need-escape.js
@@ -0,0 +1 @@
+/[\^+({*\].]/.test(raw)
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/quote-fix.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/quote-fix.js
@@ -0,0 +1 @@
+m.replace(/`/g, '\\`');
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/quote.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/quote.js
@@ -0,0 +1 @@
+m.replace(/\`/g, '\\`')
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/remove-useless-escape-fix.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/remove-useless-escape-fix.js
@@ -0,0 +1 @@
+const cleanText = code.replaceAll(/[,;()]/g, '');
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/remove-useless-escape.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/remove-useless-escape.js
@@ -0,0 +1 @@
+const cleanText = code.replaceAll(/[,;\(\)]/g, '');
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/fixture/slash.js b/packages/plugin-regexp/lib/remove-useless-escape/fixture/slash.js
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/index.js b/packages/plugin-regexp/lib/remove-useless-escape/index.js
@@ -0,0 +1,30 @@
+import {operator} from 'putout';
+import * as regexp from './regexp.js';
+
+const {transformRegExp} = operator;
+
+export const report = ({from, to}) => `Remove useless escape: ${from} -> ${to}`;
+
+export const fix = ({path, to}) => {
+    const [, pattern] = to.split('/');
+    
+    path.node.pattern = pattern;
+    path.node.raw = to;
+    path.node.extra.raw = to;
+};
+
+export const traverse = ({push}) => ({
+    RegExpLiteral(path) {
+        const from = path.node.extra.raw;
+        const [to, places] = transformRegExp(from, regexp);
+        
+        if (!places.length)
+            return;
+        
+        push({
+            path,
+            from,
+            to,
+        });
+    },
+});
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/index.spec.js b/packages/plugin-regexp/lib/remove-useless-escape/index.spec.js
@@ -0,0 +1,43 @@
+import {createTest} from '@putout/test';
+import * as plugin from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['remove-useless-escape', plugin],
+    ],
+});
+
+test('regexp: remove-useless-escape: report', (t) => {
+    t.report('remove-useless-escape', `Remove useless escape: /[,;\\(\\)]/g -> /[,;()]/g`);
+    t.end();
+});
+
+test('regexp: remove-useless-escape: transform', (t) => {
+    t.transform('remove-useless-escape');
+    t.end();
+});
+
+test('regexp: remove-useless-escape: no report: need-escape', (t) => {
+    t.noReport('need-escape');
+    t.end();
+});
+
+test('regexp: remove-useless-escape: transform: colon', (t) => {
+    t.transform('colon');
+    t.end();
+});
+
+test('regexp: remove-useless-escape: transform: quote', (t) => {
+    t.transform('quote');
+    t.end();
+});
+
+test('regexp: remove-useless-escape: transform: coma', (t) => {
+    t.transform('coma');
+    t.end();
+});
+
+test('regexp: remove-useless-escape: no report: slash', (t) => {
+    t.noReport('slash');
+    t.end();
+});
diff --git a/packages/plugin-regexp/lib/remove-useless-escape/regexp.js b/packages/plugin-regexp/lib/remove-useless-escape/regexp.js
@@ -0,0 +1,39 @@
+import {
+    isCharacterClass,
+    isAlternative,
+} from '../types.js';
+
+export const report = () => 'Avoid useless escape';
+
+export const traverse = ({push}) => ({
+    Char(path) {
+        const {parentPath} = path;
+        const {escaped, symbol} = path.node;
+        
+        if (!escaped)
+            return false;
+        
+        if (isCharacterClass(parentPath)) {
+            if (!/[()]/.test(symbol))
+                return;
+            
+            push(path);
+            return;
+        }
+        
+        if (isAlternative(parentPath)) {
+            if (!/[:,]/.test(symbol))
+                return;
+            
+            push(path);
+            return;
+        }
+        
+        if (symbol === '`')
+            push(path);
+    },
+});
+
+export const fix = (path) => {
+    path.node.escaped = false;
+};
diff --git a/packages/plugin-regexp/lib/types.js b/packages/plugin-regexp/lib/types.js
@@ -1,6 +1,7 @@
 const getType = (a) => (a.node || a).type;
 
 export const isDisjunction = (a) => getType(a) === 'Disjunction';
+export const isCharacterClass = (a) => getType(a) === 'CharacterClass';
 export const isParentDisjunction = ({parentPath}) => parentPath?.parent?.type === 'Disjunction';
 export const isChar = (a) => getType(a) === 'Char';
 export const isAlternative = (a) => getType(a) === 'Alternative';
diff --git a/packages/plugin-regexp/test/fixture/remove-useless-escape-fix.js b/packages/plugin-regexp/test/fixture/remove-useless-escape-fix.js
@@ -0,0 +1 @@
+const cleanText = code.replaceAll(/[,;()]/g, '');
diff --git a/packages/plugin-regexp/test/fixture/remove-useless-escape.js b/packages/plugin-regexp/test/fixture/remove-useless-escape.js
@@ -0,0 +1 @@
+const cleanText = code.replaceAll(/[,;\(\)]/g, '');
diff --git a/packages/plugin-regexp/test/regexp.js b/packages/plugin-regexp/test/regexp.js
@@ -61,3 +61,8 @@ test('plugin-regexp: transform: remove-duplicates-from-character-class', (t) =>
     t.transform('remove-duplicates-from-character-class');
     t.end();
 });
+
+test('plugin-regexp: transform: remove-useless-escape', (t) => {
+    t.transform('remove-useless-escape');
+    t.end();
+});
diff --git a/packages/plugin-remove-useless-escape/README.md b/packages/plugin-remove-useless-escape/README.md
@@ -27,7 +27,6 @@ npm i @putout/plugin-remove-useless-escape
 const t = 'hello \"world\"';
 const s1 = `hello \"world\"`;
 const s = `hello \'world\'`;
-const reg = /\w\:/g;
 ```
 
 ## ✅ Example of correct code
@@ -36,7 +35,6 @@ const reg = /\w\:/g;
 const t = 'hello "world"';
 const s1 = `hello "world"`;
 const s = `hello 'world'`;
-const reg = /\w:/g;
 ```
 
 ## Comparison
diff --git a/packages/plugin-remove-useless-escape/lib/remove-useless-escape.js b/packages/plugin-remove-useless-escape/lib/remove-useless-escape.js
@@ -1,9 +1,4 @@
 import emojiRegex from 'emoji-regex';
-import {types, operator} from 'putout';
-
-const {replaceWith} = operator;
-const {regExpLiteral} = types;
-const {assign} = Object;
 
 export const report = () => 'Unnecessary escape character';
 
@@ -16,38 +11,13 @@ export const fix = (path) => {
         return;
     }
     
-    if (path.isRegExpLiteral()) {
-        const {pattern, flags} = path.node;
-        
-        const unescaped = unescapeRegExp(pattern);
-        const raw = `/${unescaped}/`;
-        
-        const regExpNode = assign(regExpLiteral(unescaped, flags), {
-            value: unescaped,
-            raw,
-            extra: {
-                raw,
-                rawValue: unescaped,
-            },
-        });
-        
-        replaceWith(path, regExpNode);
-        return;
-    }
-    
     for (const tmpl of path.node.quasis) {
         const {raw} = tmpl.value;
         tmpl.value.raw = unEscape(raw);
     }
 };
 
 export const traverse = ({push}) => ({
-    'RegExpLiteral'(path) {
-        const {raw} = path.node;
-        
-        if (isEscapedRegExp(raw))
-            push(path);
-    },
     '"__"'(path) {
         const {raw} = path.node;
         
@@ -152,24 +122,3 @@ function unEscape(raw) {
     
     return raw;
 }
-
-const unescapeRegExp = (raw) => raw
-    .replaceAll('\\:', ':')
-    .replaceAll('\\+\\/', '+/')
-    .replaceAll('\\,', ',')
-    .replaceAll('\\`', '`');
-
-const is = (a) => (b) => b.includes(`\\${a}`) && !b.includes(`\\\\${a}`);
-const isRegExpColon = is(':');
-const isComa = is(',');
-const isRegExpSlash = (a) => a.includes('\\\\\\\\');
-
-function isEscapedRegExp(raw) {
-    if (raw.includes('\\/'))
-        return false;
-    
-    if (raw.includes('\\`'))
-        return true;
-    
-    return isRegExpColon(raw) || isRegExpSlash(raw) || isComa(raw);
-}
diff --git a/packages/plugin-remove-useless-escape/test/fixture/coma-fix.js b/packages/plugin-remove-useless-escape/test/fixture/coma-fix.js
@@ -1,2 +1 @@
-const badMiddle = /\},\n(s+)?\{/;
 const a = ',';
diff --git a/packages/plugin-remove-useless-escape/test/fixture/coma.js b/packages/plugin-remove-useless-escape/test/fixture/coma.js
@@ -1,2 +1 @@
-const badMiddle = /\}\,\n(s+)?\{/;
 const a = '\,';
diff --git a/packages/plugin-remove-useless-escape/test/fixture/regexp-colon-fix.js b/packages/plugin-remove-useless-escape/test/fixture/regexp-colon-fix.js
diff --git a/packages/plugin-remove-useless-escape/test/fixture/regexp-colon.js b/packages/plugin-remove-useless-escape/test/fixture/regexp-colon.js
diff --git a/packages/plugin-remove-useless-escape/test/fixture/regexp-fix.js b/packages/plugin-remove-useless-escape/test/fixture/regexp-fix.js
diff --git a/packages/plugin-remove-useless-escape/test/fixture/regexp-quote-fix.js b/packages/plugin-remove-useless-escape/test/fixture/regexp-quote-fix.js
diff --git a/packages/plugin-remove-useless-escape/test/fixture/regexp-quote.js b/packages/plugin-remove-useless-escape/test/fixture/regexp-quote.js
diff --git a/packages/plugin-remove-useless-escape/test/fixture/regexp.js b/packages/plugin-remove-useless-escape/test/fixture/regexp.js
diff --git a/packages/plugin-remove-useless-escape/test/remove-useless-escape.js b/packages/plugin-remove-useless-escape/test/remove-useless-escape.js
@@ -1,6 +1,5 @@
 import {createTest} from '@putout/test';
 import * as madrun from '@putout/plugin-madrun';
-import * as regexp from '@putout/plugin-regexp';
 import * as removeUselessEscape from '../lib/remove-useless-escape.js';
 
 const addFixLint = madrun.rules['add-fix-lint'];
@@ -76,21 +75,6 @@ test('plugin-remove-useless-escape: transform: emoji: emoji-template', (t) => {
     t.end();
 });
 
-test('plugin-remove-useless-escape: transform: regexp: regexp-colon', (t) => {
-    t.transform('regexp-colon');
-    t.end();
-});
-
-test('plugin-remove-useless-escape: transform: regexp: regexp-quote', (t) => {
-    t.transform('regexp-quote');
-    t.end();
-});
-
-test('plugin-remove-useless-escape: no transform: regexp-slash', (t) => {
-    t.noTransform('regexp-slash');
-    t.end();
-});
-
 test('plugin-remove-useless-escape: transform: plus', (t) => {
     t.transform('plus');
     t.end();
@@ -127,10 +111,3 @@ test('plugin-remove-useless-escape: transform: no-raw', (t) => {
     });
     t.end();
 });
-
-test('plugin-remove-useless-escape: transform: regexp', (t) => {
-    t.transform('regexp', {
-        regexp,
-    });
-    t.end();
-});
