feat: add options schema for prefer-promise-reject-errors (#409)

Author: camchenry

internal/rules/prefer_promise_reject_errors/options.go

@@ -14,45 +14,27 @@ func buildRejectAnErrorMessage() rule.RuleMessage {
 	}
 }
 
-type PreferPromiseRejectErrorsOptions struct {
-	AllowEmptyReject     *bool
-	AllowThrowingAny     *bool
-	AllowThrowingUnknown *bool
-}
-
 var PreferPromiseRejectErrorsRule = rule.Rule{
 	Name: "prefer-promise-reject-errors",
 	Run: func(ctx rule.RuleContext, options any) rule.RuleListeners {
-		opts, ok := options.(PreferPromiseRejectErrorsOptions)
-		if !ok {
-			opts = PreferPromiseRejectErrorsOptions{}
-		}
-		if opts.AllowEmptyReject == nil {
-			opts.AllowEmptyReject = utils.Ref(false)
-		}
-		if opts.AllowThrowingAny == nil {
-			opts.AllowThrowingAny = utils.Ref(false)
-		}
-		if opts.AllowThrowingUnknown == nil {
-			opts.AllowThrowingUnknown = utils.Ref(false)
-		}
+		opts := utils.UnmarshalOptions[PreferPromiseRejectErrorsOptions](options, "prefer-promise-reject-errors")
 
 		checkRejectCall := func(callExpression *ast.CallExpression) {
 			if len(callExpression.Arguments.Nodes) != 0 {
 				argument := callExpression.Arguments.Nodes[0]
 				t := ctx.TypeChecker.GetTypeAtLocation(argument)
 
-				if *opts.AllowThrowingAny && utils.IsTypeAnyType(t) {
+				if opts.AllowThrowingAny && utils.IsTypeAnyType(t) {
 					return
 				}
-				if *opts.AllowThrowingUnknown && utils.IsTypeUnknownType(t) {
+				if opts.AllowThrowingUnknown && utils.IsTypeUnknownType(t) {
 					return
 				}
 
 				if utils.IsErrorLike(ctx.Program, ctx.TypeChecker, t) || utils.IsReadonlyErrorLike(ctx.Program, ctx.TypeChecker, t) {
 					return
 				}
-			} else if *opts.AllowEmptyReject {
+			} else if opts.AllowEmptyReject {
 				return
 			}
 			ctx.ReportNode(&callExpression.Node, buildRejectAnErrorMessage())

internal/rules/prefer_promise_reject_errors/prefer_promise_reject_errors.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/typescript-eslint/tsgolint/internal/rule_tester"
 	"github.com/typescript-eslint/tsgolint/internal/rules/fixtures"
-	"github.com/typescript-eslint/tsgolint/internal/utils"
 )
 
 func TestPreferPromiseRejectErrors(t *testing.T) {
@@ -14,21 +13,21 @@ func TestPreferPromiseRejectErrors(t *testing.T) {
 		{Code: "Promise.resolve(5);"},
 		{
 			Code:    "Promise.reject();",
-			Options: PreferPromiseRejectErrorsOptions{AllowEmptyReject: utils.Ref(true)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowEmptyReject": true}`),
 		},
 		{
 			Code: `
         declare const someAnyValue: any;
         Promise.reject(someAnyValue);
       `,
-			Options: PreferPromiseRejectErrorsOptions{AllowThrowingAny: utils.Ref(true), AllowThrowingUnknown: utils.Ref(false)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowThrowingAny": true, "allowThrowingUnknown": false}`),
 		},
 		{
 			Code: `
         declare const someUnknownValue: unknown;
         Promise.reject(someUnknownValue);
       `,
-			Options: PreferPromiseRejectErrorsOptions{AllowThrowingAny: utils.Ref(false), AllowThrowingUnknown: utils.Ref(true)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowThrowingAny": false, "allowThrowingUnknown": true}`),
 		},
 		{Code: "Promise.reject(new Error());"},
 		{Code: "Promise.reject(new TypeError());"},
@@ -137,7 +136,7 @@ func TestPreferPromiseRejectErrors(t *testing.T) {
           reject();
         });
       `,
-			Options: PreferPromiseRejectErrorsOptions{AllowEmptyReject: utils.Ref(true)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowEmptyReject": true}`),
 		},
 		{Code: "new Promise((yes, no) => no(new Error()));"},
 		{Code: "new Promise();"},
@@ -286,14 +285,14 @@ func TestPreferPromiseRejectErrors(t *testing.T) {
         declare const someAnyValue: any;
         Promise.reject(someAnyValue);
       `,
-			Options: PreferPromiseRejectErrorsOptions{AllowThrowingAny: utils.Ref(true), AllowThrowingUnknown: utils.Ref(true)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowThrowingAny": true, "allowThrowingUnknown": true}`),
 		},
 		{
 			Code: `
         declare const someUnknownValue: unknown;
         Promise.reject(someUnknownValue);
       `,
-			Options: PreferPromiseRejectErrorsOptions{AllowThrowingAny: utils.Ref(true), AllowThrowingUnknown: utils.Ref(true)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowThrowingAny": true, "allowThrowingUnknown": true}`),
 		},
 	}, []rule_tester.InvalidTestCase{
 		{
@@ -394,7 +393,7 @@ func TestPreferPromiseRejectErrors(t *testing.T) {
 		},
 		{
 			Code:    "Promise.reject(undefined);",
-			Options: PreferPromiseRejectErrorsOptions{AllowEmptyReject: utils.Ref(true)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowEmptyReject": true}`),
 			Errors: []rule_tester.InvalidTestCaseError{
 				{
 					MessageId: "rejectAnError",
@@ -1405,7 +1404,7 @@ function fun<T extends number>(t: T): void {
         declare const someAnyValue: any;
         Promise.reject(someAnyValue);
       `,
-			Options: PreferPromiseRejectErrorsOptions{AllowThrowingAny: utils.Ref(false), AllowThrowingUnknown: utils.Ref(true)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowThrowingAny": false, "allowThrowingUnknown": true}`),
 			Errors: []rule_tester.InvalidTestCaseError{
 				{
 					MessageId: "rejectAnError",
@@ -1417,7 +1416,7 @@ function fun<T extends number>(t: T): void {
         declare const someUnknownValue: unknown;
         Promise.reject(someUnknownValue);
       `,
-			Options: PreferPromiseRejectErrorsOptions{AllowThrowingAny: utils.Ref(true), AllowThrowingUnknown: utils.Ref(false)},
+			Options: rule_tester.OptionsFromJSON[PreferPromiseRejectErrorsOptions](`{"allowThrowingAny": true, "allowThrowingUnknown": false}`),
 			Errors: []rule_tester.InvalidTestCaseError{
 				{
 					MessageId: "rejectAnError",

internal/rules/prefer_promise_reject_errors/prefer_promise_reject_errors_test.go

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "prefer_promise_reject_errors_options": {
+      "type": "object",
+      "properties": {
+        "allowEmptyReject": {
+          "type": "boolean",
+          "default": false
+        },
+        "allowThrowingAny": {
+          "type": "boolean",
+          "default": false
+        },
+        "allowThrowingUnknown": {
+          "type": "boolean",
+          "default": false
+        }
+      }
+    }
+  }
+}