fix(replace)!: issues with nested objects replacements (#903)

o-alexandrov · shellscape · commit 93cf0a73aa9c · 2021-07-16T10:27:55.000-04:00
* fix(replace): issues with nested objects replacements

* fix(replace): update tests &amp; snapshots
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -8,7 +8,8 @@ on:
 jobs:
   publish:
     # let's ignore release commits, otherwise it'll try to run twice
-    if: !startsWith(github.event.head_commit.message , 'chore(release):')
+    if: |
+      !startsWith(github.event.head_commit.message , 'chore(release):')
 
     runs-on: ubuntu-latest
 
diff --git a/packages/replace/README.md b/packages/replace/README.md
@@ -61,9 +61,14 @@ 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). See [Word Boundaries](#word-boundaries) below for more information.
+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:
+
+- `typeof window` **will** be replaced
+- `typeof window.document` **will not** be replaced due to `(?!\.)` boundary
+- `typeof windowSmth` **will not** be replaced due to a `\b` boundary
 
 ### `preventAssignment`
 
diff --git a/packages/replace/src/index.js b/packages/replace/src/index.js
@@ -46,7 +46,7 @@ export default function replace(options = {}) {
         `${escape(delimiters[0])}(${keys.join('|')})${escape(delimiters[1])}${lookahead}`,
         'g'
       )
-    : new RegExp(`\\b(${keys.join('|')})\\b${lookahead}`, 'g');
+    : new RegExp(`\\b(${keys.join('|')})\\b(?!\\.)${lookahead}`, 'g');
 
   return {
     name: 'replace',
diff --git a/packages/replace/test/fixtures/form/replace-nothing/_config.js b/packages/replace/test/fixtures/form/replace-nothing/_config.js
@@ -1,4 +1,6 @@
 module.exports = {
   description: 'replaces nothing',
-  options: {}
+  options: {
+    'typeof window': `"object"`
+  }
 };
diff --git a/packages/replace/test/fixtures/form/replace-nothing/input.js b/packages/replace/test/fixtures/form/replace-nothing/input.js
@@ -1 +1,2 @@
 console.log('as-it'); // eslint-disable-line
+console.log(typeof window.document); // eslint-disable-line
diff --git a/packages/replace/test/fixtures/form/replace-nothing/output.js b/packages/replace/test/fixtures/form/replace-nothing/output.js
@@ -1 +1,2 @@
 console.log('as-it');
+console.log(typeof window.document); // eslint-disable-line
diff --git a/packages/replace/test/fixtures/form/replace-strings/_config.js b/packages/replace/test/fixtures/form/replace-strings/_config.js
@@ -1,6 +1,7 @@
 module.exports = {
   description: 'replaces strings',
   options: {
-    ANSWER: '42'
+    ANSWER: '42',
+    'typeof window': `"object"`
   }
 };
diff --git a/packages/replace/test/fixtures/form/replace-strings/input.js b/packages/replace/test/fixtures/form/replace-strings/input.js
@@ -1 +1,2 @@
 console.log(ANSWER); // eslint-disable-line
+console.log(typeof window);
diff --git a/packages/replace/test/fixtures/form/replace-strings/output.js b/packages/replace/test/fixtures/form/replace-strings/output.js
@@ -1 +1,2 @@
 console.log(42);
+console.log('object');
diff --git a/packages/replace/test/snapshots/form.js.md b/packages/replace/test/snapshots/form.js.md
@@ -2,7 +2,13 @@
 
 The actual snapshot is saved in `form.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
+
+## assignment: doesn't replace lvalue in assignment
+
+> Snapshot 1
+
+    'process.env.DEBUG = \'test\';'
 
 ## delimiters: observes delimiters
 
@@ -37,13 +43,15 @@ Generated by [AVA](https://ava.li).
 
 > Snapshot 1
 
-    'console.log(\'as-it\'); // eslint-disable-line'
+    `console.log('as-it'); // eslint-disable-line␊
+    console.log(typeof window.document); // eslint-disable-line`
 
 ## replace-strings: replaces strings
 
 > Snapshot 1
 
-    'console.log(42); // eslint-disable-line'
+    `console.log(42); // eslint-disable-line␊
+    console.log("object");`
 
 ## replacement-function: allows replacement to be a function
 
@@ -58,9 +66,3 @@ Generated by [AVA](https://ava.li).
     `const one = 1; // eslint-disable-line␊
     ␊
     console.log(one);`
-
-## assignment: doesn't replace lvalue in assignment
-
-> Snapshot 1
-
-    'process.env.DEBUG = \'test\';'
diff --git a/packages/replace/test/snapshots/form.js.snap b/packages/replace/test/snapshots/form.js.snap
diff --git a/packages/replace/test/snapshots/misc.js.md b/packages/replace/test/snapshots/misc.js.md
@@ -2,49 +2,7 @@
 
 The actual snapshot is saved in `misc.js.snap`.
 
-Generated by [AVA](https://ava.li).
-
-## does not generate sourcemaps if disabled
-
-> Snapshot 1
-
-    'Sourcemap is likely to be incorrect: a plugin (replace) was used to transform files, but didn\'t generate a sourcemap for the transformation. Consult the plugin documentation for help'
-
-## generates sourcemaps
-
-> Snapshot 1
-
-    {
-      character: 12,
-      column: 12,
-      line: 1,
-    }
-
-> Snapshot 2
-
-    {
-      column: 15,
-      line: 1,
-      name: null,
-      source: 'other.js',
-    }
-
-> Snapshot 3
-
-    {
-      character: 17,
-      column: 0,
-      line: 3,
-    }
-
-> Snapshot 4
-
-    {
-      column: 0,
-      line: 2,
-      name: null,
-      source: 'main.js',
-    }
+Generated by [AVA](https://avajs.dev).
 
 ## no explicit setting of preventAssignment
 
diff --git a/packages/replace/test/snapshots/misc.js.snap b/packages/replace/test/snapshots/misc.js.snap
diff --git a/packages/replace/test/snapshots/sourcemaps.js.md b/packages/replace/test/snapshots/sourcemaps.js.md
@@ -2,9 +2,9 @@
 
 The actual snapshot is saved in `sourcemaps.js.snap`.
 
-Generated by [AVA](https://ava.li).
+Generated by [AVA](https://avajs.dev).
 
-## generates sourcemaps when sourcemap is used as an output argument
+## generates sourcemaps by default
 
 > Snapshot 1
 
@@ -111,75 +111,3 @@ Generated by [AVA](https://ava.li).
       name: null,
       source: 'main.js',
     }
-
-## generates sourcemaps by dfault
-
-> Snapshot 1
-
-    {
-      character: 12,
-      column: 12,
-      line: 1,
-    }
-
-> Snapshot 2
-
-    {
-      column: 15,
-      line: 1,
-      name: null,
-      source: 'other.js',
-    }
-
-> Snapshot 3
-
-    {
-      character: 17,
-      column: 0,
-      line: 3,
-    }
-
-> Snapshot 4
-
-    {
-      column: 0,
-      line: 2,
-      name: null,
-      source: 'main.js',
-    }
-
-## generates sourcemaps by default
-
-> Snapshot 1
-
-    {
-      character: 12,
-      column: 12,
-      line: 1,
-    }
-
-> Snapshot 2
-
-    {
-      column: 15,
-      line: 1,
-      name: null,
-      source: 'other.js',
-    }
-
-> Snapshot 3
-
-    {
-      character: 17,
-      column: 0,
-      line: 3,
-    }
-
-> Snapshot 4
-
-    {
-      column: 0,
-      line: 2,
-      name: null,
-      source: 'main.js',
-    }
diff --git a/packages/replace/test/snapshots/sourcemaps.js.snap b/packages/replace/test/snapshots/sourcemaps.js.snap

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ export default function replace(options = {}) {`
`46`	`46`	`${escape(delimiters[0])}(${keys.join('\|')})${escape(delimiters[1])}${lookahead}`,
`47`	`47`	`'g'`
`48`	`48`	`)`
`49`		- : new RegExp(`\\b(${keys.join('\|')})\\b${lookahead}`, 'g');
	`49`	+ : new RegExp(`\\b(${keys.join('\|')})\\b(?!\\.)${lookahead}`, 'g');
`50`	`50`
`51`	`51`	`return {`
`52`	`52`	`name: 'replace',`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`console.log('as-it'); // eslint-disable-line`
	`2`	`+console.log(typeof window.document); // eslint-disable-line`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`console.log('as-it');`
	`2`	`+console.log(typeof window.document); // eslint-disable-line`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`module.exports = {`
`2`	`2`	`description: 'replaces strings',`
`3`	`3`	`options: {`
`4`		`- ANSWER: '42'`
	`4`	`+ ANSWER: '42',`
	`5`	+ 'typeof window': `"object"`
`5`	`6`	`}`
`6`	`7`	`};`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`console.log(ANSWER); // eslint-disable-line`
	`2`	`+console.log(typeof window);`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`console.log(42);`
	`2`	`+console.log('object');`