zloirock · zloirock · Oct 1, 2023 · Sep 30, 2023 · Sep 30, 2023 · Sep 30, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 ## Changelog
 ##### Unreleased
+- Re-introduced [`RegExp` escaping stage 2 proposal](https://github.com/tc39/proposal-regex-escaping), September 2023 TC39 meeting:
+  - Added `RegExp.escape` method with the new set of symbols for escaping
+  - Some years ago, it was presented in `core-js`, but it was removed after rejecting the old version of this proposal
 - Added [`ArrayBuffer.prototype.{ transfer, transferToFixedLength }`](https://github.com/tc39/proposal-arraybuffer-transfer) and support transferring of `ArrayBuffer`s via [`structuredClone`](https://html.spec.whatwg.org/multipage/structured-data.html#dom-structuredclone) to engines with `MessageChannel`
 - Optimized [`Math.f16round`](https://github.com/tc39/proposal-float16array) polyfill
 - Fixed [some conversion cases](https://github.com/petamoriken/float16/issues/1046) of [`Math.f16round` and `DataView.prototype.{ getFloat16, setFloat16 }`](https://github.com/tc39/proposal-float16array)

diff --git a/README.md b/README.md
@@ -168,6 +168,7 @@ structuredClone(new Set([1, 2, 3])); // => new Set([1, 2, 3])
       - [`Map.prototype.emplace`](#mapprototypeemplace)
       - [`Array.isTemplateObject`](#arrayistemplateobject)
       - [`String.dedent`](#stringdedent)
+      - [`RegExp` escaping](#regexp-escaping)
       - [`Symbol` predicates](#symbol-predicates)
     - [Stage 1 proposals](#stage-1-proposals)
       - [`Observable`](#observable)
@@ -2666,6 +2667,24 @@ String.dedent(console.log)`
   print('${ message }')
 `; // => ["print('", "')", raw: Array(2)], 42
 ```
+##### [`RegExp` escaping](https://github.com/tc39/proposal-regex-escaping)[⬆](#index)
+Module [`esnext.regexp.escape`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.regexp.escape.js)
+```js
+class RegExp {
+  static escape(value: string): string
+}
+```
+[*CommonJS entry points:*](#commonjs-api)
+```js
+core-js/proposals/regexp-escaping
+core-js(-pure)/full/regexp/escape
+```
+[*Example*](https://tinyurl.com/yqvehz5c):
+```js
+console.log(RegExp.escape('10$')); // => '\\x310\\$'
+console.log(RegExp.escape('abcdefg_123456')); // => 'abcdefg_123456'
+console.log(RegExp.escape('(){}[]|,.?*+-^$=<>\\/#&!%:;@~\'"`')); // => '\\(\\)\\{\\}\\[\\]\\|\\,\\.\\?\\*\\+\\-\\^\\$\\=\\<\\>\\\\\\/\\#\\&\\!\\%\\:\\;\\@\\~\\\'\\"\\`'
+```
 ##### [`Symbol` predicates](https://github.com/tc39/proposal-symbol-predicates)[⬆](#index)
 Modules [`esnext.symbol.is-registered-symbol`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.symbol.is-registered-symbol.js), [`esnext.symbol.is-well-known-symbol`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.symbol.is-well-known-symbol.js).
 ```js

diff --git a/packages/core-js-compat/src/data.mjs b/packages/core-js-compat/src/data.mjs
@@ -2186,6 +2186,8 @@ export const data = {
   // TODO: Remove from `core-js@4`
   'esnext.reflect.metadata': {
   },
+  'esnext.regexp.escape': {
+  },
   'esnext.set.add-all': {
   },
   'esnext.set.delete-all': {

diff --git a/packages/core-js-compat/src/modules-by-versions.mjs b/packages/core-js-compat/src/modules-by-versions.mjs
@@ -220,4 +220,7 @@ export default {
     'esnext.data-view.set-uint8-clamped',
     'esnext.math.f16round',
   ],
+  3.33: [
+    'esnext.regexp.escape',
+  ],
 };
diff --git a/packages/core-js/full/regexp/escape.js b/packages/core-js/full/regexp/escape.js
@@ -0,0 +1,5 @@
+'use strict';
+require('../../modules/esnext.regexp.escape');
+var path = require('../../internals/path');
+
+module.exports = path.RegExp.escape;
diff --git a/packages/core-js/full/regexp/index.js b/packages/core-js/full/regexp/index.js
@@ -1,4 +1,5 @@
 'use strict';
 var parent = require('../../actual/regexp');
+require('../../modules/esnext.regexp.escape');
 
 module.exports = parent;
diff --git a/packages/core-js/modules/esnext.regexp.escape.js b/packages/core-js/modules/esnext.regexp.escape.js
@@ -0,0 +1,20 @@
+'use strict';
+var $ = require('../internals/export');
+var uncurryThis = require('../internals/function-uncurry-this');
+var toString = require('../internals/to-string');
+var WHITESPACES = require('../internals/whitespaces');
+
+var charCodeAt = uncurryThis(''.charCodeAt);
+var replace = uncurryThis(''.replace);
+var NEED_ESCAPING = RegExp('[!"#$%&\'()*+,\\-./:;<=>?@[\\\\\\]^`{|}~' + WHITESPACES + ']', 'g');
+
+// `RegExp.escape` method
+// https://github.com/tc39/proposal-regex-escaping
+$({ target: 'RegExp', stat: true, forced: true }, {
+  escape: function escape(S) {
+    var str = toString(S);
+    var firstCode = charCodeAt(str, 0);
+    // escape first DecimalDigit
+    return (firstCode > 47 && firstCode < 58 ? '\\x3' : '') + replace(str, NEED_ESCAPING, '\\$&');
+  }
+});
diff --git a/packages/core-js/proposals/regexp-escaping.js b/packages/core-js/proposals/regexp-escaping.js
@@ -0,0 +1,3 @@
+'use strict';
+// https://github.com/tc39/proposal-regex-escaping
+require('../modules/esnext.regexp.escape');
diff --git a/packages/core-js/stage/2.js b/packages/core-js/stage/2.js
@@ -5,6 +5,7 @@ require('../proposals/array-is-template-object');
 require('../proposals/async-iterator-helpers');
 require('../proposals/iterator-range');
 require('../proposals/map-upsert-stage-2');
+require('../proposals/regexp-escaping');
 require('../proposals/string-dedent');
 require('../proposals/symbol-predicates-v2');
 // TODO: Obsolete versions, remove from `core-js@4`

diff --git a/tests/compat/tests.js b/tests/compat/tests.js
@@ -1747,6 +1747,9 @@ GLOBAL.tests = {
   'esnext.promise.with-resolvers': [PROMISES_SUPPORT, function () {
     return Promise.withResolvers;
   }],
+  'esnext.regexp.escape': function () {
+    return RegExp.escape;
+  },
   'esnext.set.add-all': function () {
     return Set.prototype.addAll;
   },

diff --git a/tests/entries/unit.mjs b/tests/entries/unit.mjs
@@ -819,6 +819,7 @@ for (PATH of ['core-js-pure', 'core-js']) {
     ok(typeof load(NS, 'reflect/has-own-metadata') == 'function');
     ok(typeof load(NS, 'reflect/metadata') == 'function');
     ok(load(NS, 'promise/try')(() => 42) instanceof load(NS, 'promise'));
+    ok(load(NS, 'regexp/escape')('10$') === '\\x310\\$');
     ok(load(NS, 'set/add-all')(new Set([1, 2, 3]), 4, 5).size === 5);
     ok(load(NS, 'set/delete-all')(new Set([1, 2, 3]), 4, 5) === false);
     ok(load(NS, 'set/every')(new Set([1, 2, 3]), it => typeof it == 'number'));
@@ -953,6 +954,7 @@ for (PATH of ['core-js-pure', 'core-js']) {
   load('proposals/promise-with-resolvers');
   load('proposals/reflect-metadata');
   load('proposals/regexp-dotall-flag');
+  load('proposals/regexp-escaping');
   load('proposals/regexp-named-groups');
   load('proposals/relative-indexing-method');
   load('proposals/seeded-random');

diff --git a/tests/unit-global/esnext.regexp.escape.js b/tests/unit-global/esnext.regexp.escape.js
@@ -0,0 +1,27 @@
+import { createConversionChecker } from '../helpers/helpers.js';
+
+QUnit.test('RegExp.escape', assert => {
+  const { escape } = RegExp;
+  assert.isFunction(escape);
+  assert.arity(escape, 1);
+  assert.name(escape, 'escape');
+  assert.looksNative(escape);
+  assert.nonEnumerable(RegExp, 'escape');
+
+  assert.same(escape('10$'), '\\x310\\$', '10$');
+  assert.same(escape('abcdefg_123456'), 'abcdefg_123456', 'abcdefg_123456');
+  assert.same(
+    escape('(){}[]|,.?*+-^$=<>\\/#&!%:;@~\'"`'),
+    '\\(\\)\\{\\}\\[\\]\\|\\,\\.\\?\\*\\+\\-\\^\\$\\=\\<\\>\\\\\\/\\#\\&\\!\\%\\:\\;\\@\\~\\\'\\"\\`',
+    '(){}[]|,.?*+-^$=<>\\/#&!%:;@~\'"`',
+  );
+
+  const checker = createConversionChecker('10$');
+  assert.same(escape(checker), '\\x310\\$', 'checker result');
+  assert.same(checker.$valueOf, 0, 'checker valueOf calls');
+  assert.same(checker.$toString, 1, 'checker toString calls');
+
+  if (typeof Symbol == 'function' && !Symbol.sham) {
+    assert.throws(() => escape(Symbol('thrower')), TypeError, 'throws on symbol');
+  }
+});
diff --git a/tests/unit-pure/esnext.regexp.escape.js b/tests/unit-pure/esnext.regexp.escape.js
@@ -0,0 +1,26 @@
+import escape from 'core-js-pure/full/regexp/escape';
+import Symbol from 'core-js-pure/es/symbol';
+import { createConversionChecker } from '../helpers/helpers.js';
+
+QUnit.test('RegExp.escape', assert => {
+  assert.isFunction(escape);
+  assert.arity(escape, 1);
+  assert.name(escape, 'escape');
+
+  assert.same(escape('10$'), '\\x310\\$', '10$');
+  assert.same(escape('abcdefg_123456'), 'abcdefg_123456', 'abcdefg_123456');
+  assert.same(
+    escape('(){}[]|,.?*+-^$=<>\\/#&!%:;@~\'"`'),
+    '\\(\\)\\{\\}\\[\\]\\|\\,\\.\\?\\*\\+\\-\\^\\$\\=\\<\\>\\\\\\/\\#\\&\\!\\%\\:\\;\\@\\~\\\'\\"\\`',
+    '(){}[]|,.?*+-^$=<>\\/#&!%:;@~\'"`',
+  );
+
+  const checker = createConversionChecker('10$');
+  assert.same(escape(checker), '\\x310\\$', 'checker result');
+  assert.same(checker.$valueOf, 0, 'checker valueOf calls');
+  assert.same(checker.$toString, 1, 'checker toString calls');
+
+  if (!Symbol.sham) {
+    assert.throws(() => escape(Symbol('thrower')), TypeError, 'throws on symbol');
+  }
+});