lib: validate Error.captureStackTrace() calls

This adds a custom eslint rule to verify that
`Error.captureStackTrace()` is only called if necessary. In most
cases the helper function should be used instead.

PR-URL: https://github.com/nodejs/node/pull/26738
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

1 files changed, 2 insertions, 0 deletions

diff --git a/lib/fs.js b/lib/fs.js
index 46dd447d3e..cfe856eaeb 100644
--- a/lib/fs.js
+++ b/lib/fs.js
@@ -117,6 +117,7 @@ function showTruncateDeprecation() {
 function handleErrorFromBinding(ctx) {
   if (ctx.errno !== undefined) {  // libuv error numbers
     const err = uvException(ctx);
+    // eslint-disable-next-line no-restricted-syntax
     Error.captureStackTrace(err, handleErrorFromBinding);
     throw err;
   }
@@ -124,6 +125,7 @@ function handleErrorFromBinding(ctx) {
     // TODO(joyeecheung): currently, ctx.error are encoding errors
     // usually caused by memory problems. We need to figure out proper error
     // code(s) for this.
+    // eslint-disable-next-line no-restricted-syntax
     Error.captureStackTrace(ctx.error, handleErrorFromBinding);
     throw ctx.error;
   }