fix(replace)!: do not escape delimiters (#1088)

* fix(replace)!: do not escape delimiters BREAKING CHANGES: user is now responsible for escaping delimiters * docs(replace): document delimiter escaping

Author: guansss

packages/replace/README.md

@@ -61,7 +61,7 @@ In addition to the properties and values specified for replacement, users may al
 ### `delimiters`
 
 Type: `Array[String, String]`<br>
-Default: `['\b', '\b(?!\.)']`
+Default: `['\\b', '\\b(?!\\.)']`
 
 Specifies the boundaries around which strings will be replaced. By default, delimiters are [word boundaries](https://www.regular-expressions.info/wordboundaries.html) and also prevent replacements of instances with nested access. See [Word Boundaries](#word-boundaries) below for more information.
 For example, if you pass `typeof window` in `values` to-be-replaced, then you could expect the following scenarios:
@@ -70,6 +70,8 @@ For example, if you pass `typeof window` in `values` to-be-replaced, then you co
 - `typeof window.document` **will not** be replaced due to `(?!\.)` boundary
 - `typeof windowSmth` **will not** be replaced due to a `\b` boundary
 
+Delimiters will be used to build a `Regexp`. To match special characters (any of `.*+?^${}()|[]\`), be sure to [escape](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping) them.
+
 ### `objectGuards`
 
 Type: `Boolean`<br>

packages/replace/src/index.js

@@ -68,18 +68,16 @@ function expandTypeofReplacements(replacements) {
 
 export default function replace(options = {}) {
  const filter = createFilter(options.include, options.exclude);
- const { delimiters, preventAssignment, objectGuards } = options;
+ const { delimiters = ['\\b', '\\b(?!\\.)'], preventAssignment, objectGuards } = options;
  const replacements = getReplacements(options);
  if (objectGuards) expandTypeofReplacements(replacements);
  const functionValues = mapToFunctions(replacements);
  const keys = Object.keys(functionValues).sort(longest).map(escape);
  const lookahead = preventAssignment ? '(?!\\s*=[^=])' : '';
- const pattern = delimiters
- ? new RegExp(
- `${escape(delimiters[0])}(${keys.join('|')})${escape(delimiters[1])}${lookahead}`,
- 'g'
- )
- : new RegExp(`\\b(${keys.join('|')})\\b(?!\\.)${lookahead}`, 'g');
+ const pattern = new RegExp(
+ `${delimiters[0]}(${keys.join('|')})${delimiters[1]}${lookahead}`,
+ 'g'
+ );
 
  return {
  name: 'replace',

packages/replace/test/fixtures/form/special-delimiters/_config.js

@@ -0,0 +1,7 @@
+module.exports = {
+ description: 'allows delimiters with special characters',
+ options: {
+ special: 'replaced',
+ delimiters: ['\\b', '\\b']
+ }
+};

packages/replace/test/fixtures/form/special-delimiters/input.js

@@ -0,0 +1,7 @@
+console.log(`
+ special
+ (special)
+ specially
+ especial
+ special.doSomething()
+`);

packages/replace/test/fixtures/form/special-delimiters/output.js

@@ -0,0 +1,7 @@
+console.log(`
+ replaced
+ (replaced)
+ specially
+ especial
+ replaced.doSomething()
+`);

packages/replace/test/snapshots/form.js.md

@@ -74,3 +74,15 @@ Generated by [AVA](https://avajs.dev).
  `const one = 1; // eslint-disable-line␊
  ␊
  console.log(one);`
+
+## special-delimiters: allows delimiters with special characters
+
+> Snapshot 1
+
+ `console.log(`␊
+  replaced␊
+  (replaced)␊
+  specially␊
+  especial␊
+  replaced.doSomething()␊
+ `);`