tools: add assert.doesNotThrow eslint rule

Prohibit the usage of `assert.doesNotThrow()`. Backport-PR-URL: #19244 PR-URL: #18669 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
nodejs · Mar 21, 2018 · d795865 · d795865
1 parent 1eac1d7
commit d795865
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 7 deletions.
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
@@ -137,8 +137,11 @@ rules:
   no-mixed-spaces-and-tabs: error
   no-multiple-empty-lines: [error, {max: 2, maxEOF: 0, maxBOF: 0}]
   no-restricted-syntax: [error, {
+    selector: "CallExpression[callee.object.name='assert'][callee.property.name='doesNotThrow']",
+    message: "Please replace `assert.doesNotThrow()` and add a comment next to the code instead."
+  }, {
     selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.1.type='Literal']:not([arguments.1.regex])",
-    message: "use a regular expression for second argument of assert.throws()"
+    message: "Use a regular expression for second argument of assert.throws()"
   }, {
     selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.length<2]",
     message: "assert.throws() must be invoked with at least two arguments."

diff --git a/benchmark/assert/throws.js b/benchmark/assert/throws.js
@@ -26,6 +26,7 @@ function main({ n, method }) {
     case 'doesNotThrow':
       bench.start();
       for (i = 0; i < n; ++i) {
+        // eslint-disable-next-line no-restricted-syntax
         assert.doesNotThrow(doesNotThrow);
       }
       bench.end(n);

diff --git a/doc/api/assert.md b/doc/api/assert.md
@@ -346,6 +346,7 @@ to the caller.
 The following, for instance, will throw the [`TypeError`][] because there is no
 matching error type in the assertion:
 
+<!-- eslint-disable no-restricted-syntax -->
 ```js
 assert.doesNotThrow(
   () => {
@@ -358,6 +359,7 @@ assert.doesNotThrow(
 However, the following will result in an `AssertionError` with the message
 'Got unwanted exception (TypeError)..':
 
+<!-- eslint-disable no-restricted-syntax -->
 ```js
 assert.doesNotThrow(
   () => {
@@ -371,6 +373,7 @@ If an `AssertionError` is thrown and a value is provided for the `message`
 parameter, the value of `message` will be appended to the `AssertionError`
 message:
 
+<!-- eslint-disable no-restricted-syntax -->
 ```js
 assert.doesNotThrow(
   () => {

diff --git a/test/parallel/test-assert.js b/test/parallel/test-assert.js
@@ -120,7 +120,7 @@ assert.ifError(null);
 assert.ifError();
 
 common.expectsError(
-  () => assert.doesNotThrow(() => thrower(Error), 'user message'),
+  () => a.doesNotThrow(() => thrower(Error), 'user message'),
   {
     type: a.AssertionError,
     code: 'ERR_ASSERTION',
@@ -130,15 +130,15 @@ common.expectsError(
 );
 
 common.expectsError(
-  () => assert.doesNotThrow(() => thrower(Error), 'user message'),
+  () => a.doesNotThrow(() => thrower(Error), 'user message'),
   {
     code: 'ERR_ASSERTION',
     message: /Got unwanted exception: user message\n\[object Object\]/
   }
 );
 
 common.expectsError(
-  () => assert.doesNotThrow(() => thrower(Error)),
+  () => a.doesNotThrow(() => thrower(Error)),
   {
     code: 'ERR_ASSERTION',
     message: /Got unwanted exception\.\n\[object Object\]/
@@ -307,7 +307,7 @@ try {
 
   // Verify AssertionError is the result from doesNotThrow with custom Error.
   try {
-    assert.doesNotThrow(() => {
+    a.doesNotThrow(() => {
       throw new TypeError('wrong type');
     }, TypeError, rangeError);
   } catch (e) {
@@ -645,7 +645,7 @@ common.expectsError(
   );
 
   common.expectsError(
-    () => assert.doesNotThrow(() => { throw new Error(); }, { foo: 'bar' }),
+    () => a.doesNotThrow(() => { throw new Error(); }, { foo: 'bar' }),
     {
       type: TypeError,
       code: 'ERR_INVALID_ARG_TYPE',
@@ -676,7 +676,7 @@ common.expectsError(
   assert.throws(() => { throw undefined; }, /undefined/);
   common.expectsError(
     // eslint-disable-next-line no-throw-literal
-    () => assert.doesNotThrow(() => { throw undefined; }),
+    () => a.doesNotThrow(() => { throw undefined; }),
     {
       type: assert.AssertionError,
       code: 'ERR_ASSERTION',