Disable @typescript-eslint/prefer-promise-reject-errors rule

[Mrtenz]

This disables the @typescript-eslint/prefer-promise-reject-errors rule, which enforces that Promise.reject must be called with an instance of Error. This rule seems too strict, especially in cases when working with try-catch for example:

new Promise((resolve, reject) => {
  try {
    return resolve(doSomething());
  } catch (error) {
    return reject(error);
  }
});

In this case we could wrap the error in new Error(), but if it's already an Error, we would loose information like the stack trace etc., so we'd need to add more code to try to handle the case where error is an Error, or a string, object.

if (error instanceof Error) {
  return reject(error);
}

if (isJsonRpcError(error)) {
  return reject(serializeJsonRpcError(error));
}

return reject(new Error(error));

While this rule seems useful in some cases, I feel like it's too strict for us.

[Gudahtt]

To clarify, are you saying that it's too strict because we'd be forced to verify that the error is an instance of Error?

Surely we're not intentionally throwing non-Errors. That's what I saw as the benefit of this rule - it's an additional check to ensure we're not throwing a non-Error.

If handling unknown is the only concern, there is an option for that: https://typescript-eslint.io/rules/prefer-promise-reject-errors/

[Mrtenz]

To clarify, are you saying that it's too strict because we'd be forced to verify that the error is an instance of Error?

Yes. It was causing a lot of errors in Snaps at least.

Surely we're not intentionally throwing non-Errors. That's what I saw as the benefit of this rule - it's an additional check to ensure we're not throwing a non-Error.

If handling unknown is the only concern, there is an option for that: https://typescript-eslint.io/rules/prefer-promise-reject-errors/

Good point. I wasn't aware of that option, that seems like a good alternative to completely disabling the rule.