Support SuppressedError (#2669)

Author: fisker

docs/rules/error-message.md

@@ -7,34 +7,39 @@
 
 This rule enforces a `message` value to be passed in when creating an instance of a built-in [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object, which leads to more readable and debuggable code.
 
-## Fail
+## Examples
 
 ```js
-throw Error();
-```
+// ❌
+throw new Error();
 
-```js
-throw Error('');
+// ❌
+throw new Error('');
+
+// ✅
+throw new Error('Unexpected property.');
 ```
 
 ```js
+// ❌
 throw new TypeError();
+
+// ✅
+throw new TypeError('Array expected.');
 ```
 
 ```js
+// ❌
 const error = new AggregateError(errors);
-```
-
-## Pass
 
-```js
-throw Error('Unexpected property.');
+// ✅
+const error = new AggregateError(errors, 'Promises rejected.');
 ```
 
 ```js
-throw new TypeError('Array expected.');
-```
+// ❌
+const error = new SuppressedError(error, suppressed);
 
-```js
-const error = new AggregateError(errors, 'Promises rejected.');
+// ✅
+const error = new SuppressedError(error, suppressed, 'This is a suppressed error.');
 ```

rules/error-message.js

@@ -12,6 +12,11 @@ const messages = {
 	[MESSAGE_ID_NOT_STRING]: 'Error message should be a string.',
 };
 
+const messageArgumentIndexes = new Map([
+	['AggregateError', 1],
+	['SuppressedError', 2],
+]);
+
 /** @param {import('eslint').Rule.RuleContext} context */
 const create = context => {
 	context.on(['CallExpression', 'NewExpression'], expression => {
@@ -28,7 +33,9 @@ const create = context => {
 		}
 
 		const constructorName = expression.callee.name;
-		const messageArgumentIndex = constructorName === 'AggregateError' ? 1 : 0;
+		const messageArgumentIndex = messageArgumentIndexes.has(constructorName)
+			? messageArgumentIndexes.get(constructorName)
+			: 0;
 		const callArguments = expression.arguments;
 
 		// If message is `SpreadElement` or there is `SpreadElement` before message

rules/shared/builtin-errors.js

@@ -9,6 +9,7 @@ const builtinErrors = [
 	'URIError',
 	'InternalError',
 	'AggregateError',
+	'SuppressedError',
 ];
 
 export default builtinErrors;

test/error-message.js

@@ -104,3 +104,39 @@ test.snapshot({
 		'const error = new AggregateError;',
 	],
 });
+
+// `SuppressedError`
+test.snapshot({
+	valid: [
+		'new SuppressedError(error, suppressed, "message")',
+		'new NotSuppressedError(error, suppressed)',
+		'new SuppressedError(...foo)',
+		'new SuppressedError(...foo, "")',
+		'new SuppressedError(error, suppressed, ...foo)',
+		'new SuppressedError(error, suppressed, message, "")',
+		'new SuppressedError("", "", message, "")',
+	],
+	invalid: [
+		'new SuppressedError(error, suppressed,)',
+		'new SuppressedError(error,)',
+		'new SuppressedError()',
+		'SuppressedError(error, suppressed,)',
+		'SuppressedError(error,)',
+		'SuppressedError()',
+		'new SuppressedError(error, suppressed, "")',
+		'new SuppressedError(error, suppressed, ``)',
+		'new SuppressedError(error, suppressed, "", options)',
+		outdent`
+			const errorMessage = Object.freeze({errorMessage: 1}).errorMessage;
+			throw new SuppressedError(error, suppressed, errorMessage)
+		`,
+		'new SuppressedError(error, suppressed, [])',
+		'new SuppressedError(error, suppressed, [foo])',
+		'new SuppressedError(error, suppressed, [0][0])',
+		'new SuppressedError(error, suppressed, {})',
+		'new SuppressedError(error, suppressed, {foo})',
+		'new SuppressedError(error, suppressed, {foo: 0}.foo)',
+		'new SuppressedError(error, suppressed, lineNumber=2)',
+		'const error = new SuppressedError;',
+	],
+});

test/no-instanceof-builtins.js

@@ -25,6 +25,7 @@ const strictStrategyInvalid = [
 	'foo instanceof URIError',
 	'foo instanceof InternalError',
 	'foo instanceof AggregateError',
+	'foo instanceof SuppressedError',
 
 	// Collection types
 	'foo instanceof Map',
@@ -102,6 +103,7 @@ test.snapshot({
 		'err instanceof URIError',
 		'err instanceof InternalError',
 		'err instanceof AggregateError',
+		'err instanceof SuppressedError',
 	].map(code => ({code, options: [{useErrorIsError: true, strategy: 'strict'}]})),
 });