fix: Expand error types in node-execute-block-wrong-error-thrown (#192

)

* fix: Expand error types in `node-execute-block-wrong-error-thrown`

* Fix missing bracket

README.md

@@ -121,7 +121,7 @@ In the `community` ruleset, the five `*-still-default` rules allow you to define
 | [node-execute-block-double-assertion-for-items](docs/rules/node-execute-block-double-assertion-for-items.md) | In the `execute()` method there is no need to double assert the type of `items.length`. | Yes |
 | [node-execute-block-error-missing-item-index](docs/rules/node-execute-block-error-missing-item-index.md) | In the operations in the `execute()` method in a node, `NodeApiError` and `NodeOperationError` must specify `itemIndex` as the third argument. | No |
 | [node-execute-block-missing-continue-on-fail](docs/rules/node-execute-block-missing-continue-on-fail.md) | The `execute()` method in a node must implement `continueOnFail` in a try-catch block. | No |
-| [node-execute-block-wrong-error-thrown](docs/rules/node-execute-block-wrong-error-thrown.md) | The `execute()` method in a node may only throw `NodeApiError` for failed API requests and `NodeOperationError` for internal errors, not the built-in `Error`. Refer to [`NodeErrors.ts`](https://github.com/n8n-io/n8n/blob/master/packages/workflow/src/NodeErrors.ts). | No |
+| [node-execute-block-wrong-error-thrown](docs/rules/node-execute-block-wrong-error-thrown.md) | The `execute()` method in a node may only throw `ApplicationError`, NodeApiError`, `NodeOperationError`, or `TriggerCloseError`. | No |
 | [node-filename-against-convention](docs/rules/node-filename-against-convention.md) | `name` in node class description must match the node filename without the `.node.ts` suffix. Example: If `description.name` is `Test`, then filename must be `Test.node.ts`. Version suffix in filename (e.g. `-V2`) is disregarded. | No |
 | [node-param-array-type-assertion](docs/rules/node-param-array-type-assertion.md) | Array of node parameters must be typed, not type-asserted. | Yes |
 | [node-param-collection-type-item-required](docs/rules/node-param-collection-type-item-required.md) | Items in collection-type node parameter must not have a `required` property. | Yes |

docs/rules/node-execute-block-wrong-error-thrown.md

@@ -2,7 +2,7 @@
 
 # node-execute-block-wrong-error-thrown
 
-The `execute()` method in a node may only throw `NodeApiError` for failed API requests and `NodeOperationError` for internal errors, not the built-in `Error`. Refer to [`NodeErrors.ts`](https://github.com/n8n-io/n8n/blob/master/packages/workflow/src/NodeErrors.ts).
+The `execute()` method in a node may only throw `ApplicationError`, NodeApiError`, `NodeOperationError`, or `TriggerCloseError`.
 
 📋 This rule is part of the `plugin:n8n-nodes-base/nodes` config.
 
@@ -32,6 +32,18 @@ class TestNode {
 		throw new NodeOperationError(this.getNode(), "An error occurred");
 	}
 }
+
+class TestNode {
+	execute() {
+		throw new ApplicationError("An error occurred", { level: "warning" });
+	}
+}
+
+class TestNode {
+	execute() {
+		throw new TriggerCloseError(this.getNode);
+	}
+}
 ```
 
 ## Links

lib/constants.ts

@@ -187,7 +187,12 @@ export const DOCUMENTATION = {
 //              misc
 // ----------------------------------
 
-export const N8N_NODE_ERROR_TYPES = ["NodeOperationError", "NodeApiError"];
+export const N8N_NODE_ERROR_TYPES = [
+	"ApplicationError",
+	"NodeOperationError",
+	"NodeApiError",
+	"TriggerCloseError",
+];
 
 /**
  * Credentials exempted from these rules:

lib/rules/node-execute-block-wrong-error-thrown.ts

@@ -8,13 +8,13 @@ export default utils.createRule({
 		type: "problem",
 		docs: {
 			description:
-				"The `execute()` method in a node may only throw `NodeApiError` for failed API requests and `NodeOperationError` for internal errors, not the built-in `Error`. Refer to [`NodeErrors.ts`](https://github.com/n8n-io/n8n/blob/master/packages/workflow/src/NodeErrors.ts).",
+				"The `execute()` method in a node may only throw `ApplicationError`, NodeApiError`, `NodeOperationError`, or `TriggerCloseError`.",
 			recommended: "strict",
 		},
 		schema: [],
 		messages: {
 			useProperError:
-				"Use `NodeApiError` or `NodeOperationError` [non-autofixable]",
+				"Use `ApplicationError`, NodeApiError`, `NodeOperationError`, or `TriggerCloseError` [non-autofixable]",
 		},
 	},
 	defaultOptions: [],

tests/node-execute-block-wrong-error-thrown.test.ts

@@ -21,6 +21,22 @@ ruleTester().run(getRuleName(module), rule, {
 				}
 			}`,
 		},
+		{
+			code: outdent`
+			class TestNode {
+				execute() {
+					throw new ApplicationError('An error occurred', { level: "warning" });
+				}
+			}`,
+		},
+		{
+			code: outdent`
+			class TestNode {
+				execute() {
+					throw new TriggerCloseError(this.getNode());
+				}
+			}`,
+		},
 	],
 	invalid: [
 		{