Merge pull request #36 from unassert-js/await-expression

twada · web-flow · commit aa73d715e8ae · 2022-07-31T16:10:12.000+09:00
feat: Support removal of async assertion such as `assert.rejects`
diff --git a/README.md b/README.md
@@ -115,7 +115,7 @@ Object for configuration options. passed `options` is `Object.assign`ed with def
 
 ##### options.modules
 
-Target module names for `require` and `import` call removal.
+Target module names for assertion call removal.
 
 For example, the default target modules are as follows.
 
@@ -173,12 +173,14 @@ In this default case, unassert will remove assertion calls such as,
 * `assert.notDeepEqual(actual, expected, [message])`
 * `assert.deepStrictEqual(actual, expected, [message])`
 * `assert.notDeepStrictEqual(actual, expected, [message])`
-* `assert.fail([message])`
-* `assert.fail(actual, expected, message, operator)`
+* `assert.match(string, regexp[, message])`
+* `assert.doesNotMatch(string, regexp[, message])`
 * `assert.throws(block, [error], [message])`
 * `assert.doesNotThrow(block, [message])`
-* `assert.rejects(asyncFn, [error], [message])`
-* `assert.doesNotReject(asyncFn, [error], [message])`
+* `await assert.rejects(asyncFn, [error], [message])`
+* `await assert.doesNotReject(asyncFn, [error], [message])`
+* `assert.fail([message])`
+* `assert.fail(actual, expected, message, operator)`
 * `assert.ifError(value)`
 
 in addition, unassert removes `console.assert` calls as well.
@@ -251,7 +253,7 @@ import { strict as powerAssert } from 'power-assert';
 import { default as looseAssert } from 'node:assert';
 import strictAssert, { ok, equal as eq } from 'node:assert/strict';
 
-function add (a, b) {
+async function add (a, b) {
   strictAssert(!isNaN(a));
   looseAssert(typeof a === 'number');
   eq(typeof b, 'number');
@@ -267,14 +269,17 @@ function add (a, b) {
   invariant(someTruthyVal, 'This will not throw');
   invariant(someFalseyVal, 'This will throw an error with this message');
 
+  await strictAssert.rejects(prms);
+  await strictAssert.doesNotReject(prms2);
+
   return a + b;
 }
 ```
 
 output:
 
 ```javascript
-function add(a, b) {
+async function add(a, b) {
   return a + b;
 }
 ```
diff --git a/src/index.mjs b/src/index.mjs
@@ -228,6 +228,18 @@ function createVisitor (options) {
           }
           break;
         }
+        case syntax.AwaitExpression: {
+          const childNode = currentNode.argument;
+          if (isExpressionStatement(parentNode) && isCallExpression(childNode)) {
+            const callee = childNode.callee;
+            if (isAssertionFunction(callee) || isAssertionMethod(callee) || isConsoleAssert(callee)) {
+              // remove parent ExpressionStatement
+              nodeToRemove.add(parentNode);
+              this.skip();
+            }
+          }
+          break;
+        }
       }
     },
     leave: function (currentNode, parentNode) {
diff --git a/test/fixtures/various_assertion_methods/expected.js b/test/fixtures/various_assertion_methods/expected.js
@@ -1,4 +1,4 @@
 'use strict';
-function add(a, b) {
+async function add(a, b) {
     return a + b;
 }
diff --git a/test/fixtures/various_assertion_methods/fixture.js b/test/fixtures/various_assertion_methods/fixture.js
@@ -2,7 +2,7 @@
 
 const assert = require('node:assert');
 
-function add (a, b) {
+async function add (a, b) {
     console.assert(typeof a === 'number');
 
     assert(!isNaN(a));
@@ -54,5 +54,9 @@ function add (a, b) {
 
     assert.ifError(a);
     assert.fail(a, b, 'assertion message', '==');
+
+    await assert.rejects(prms);
+    await assert.doesNotReject(prms2);
+
     return a + b;
 }

Original file line number	Diff line number	Diff line change
`@@ -228,6 +228,18 @@ function createVisitor (options) {`
`228`	`228`	`}`
`229`	`229`	`break;`
`230`	`230`	`}`
	`231`	`+ case syntax.AwaitExpression: {`
	`232`	`+ const childNode = currentNode.argument;`
	`233`	`+ if (isExpressionStatement(parentNode) && isCallExpression(childNode)) {`
	`234`	`+ const callee = childNode.callee;`
	`235`	`+ if (isAssertionFunction(callee) \|\| isAssertionMethod(callee) \|\| isConsoleAssert(callee)) {`
	`236`	`+ // remove parent ExpressionStatement`
	`237`	`+ nodeToRemove.add(parentNode);`
	`238`	`+ this.skip();`
	`239`	`+ }`
	`240`	`+ }`
	`241`	`+ break;`
	`242`	`+ }`
`231`	`243`	`}`
`232`	`244`	`},`
`233`	`245`	`leave: function (currentNode, parentNode) {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`'use strict';`
`2`		`-function add(a, b) {`
	`2`	`+async function add(a, b) {`
`3`	`3`	`return a + b;`
`4`	`4`	`}`