@n8n/eslint-plugin-community-nodes 0.27.0 → 0.28.0

package/docs/rules/no-restricted-globals.md

@@ -33,12 +33,26 @@ export class MyNode implements INodeType {
 ### ✅ Correct
 
 ```typescript
+import { sleep } from 'n8n-workflow';
+
 export class MyNode implements INodeType {
   async execute(this: IExecuteFunctions) {
     // Use n8n context methods instead
     const timezone = this.getTimezone();
 
+    // Use the sleep helper instead of setTimeout
+    await sleep(1000);
+
     return this.prepareOutputData([]);
   }
 }
 ```
+
+## Alternatives to restricted timer globals
+
+`n8n-workflow` exports helpers that work the same everywhere, including on
+n8n Cloud, instead of reaching for the restricted timer globals directly:
+
+- Instead of `setTimeout(resolve, ms)`, use `await sleep(ms)`.
+- Instead of `setTimeout` + `clearTimeout` for a cancellable delay, use
+  `await sleepWithAbort(ms, abortSignal)`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@n8n/eslint-plugin-community-nodes",
   "type": "module",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "main": "./dist/plugin.js",
   "types": "./dist/plugin.d.ts",
   "exports": {
@@ -27,7 +27,7 @@
     "vitest": "^4.1.9",
     "@n8n/typescript-config": "1.9.0",
     "@n8n/vitest-config": "1.19.0",
-    "n8n-workflow": "2.33.0"
+    "n8n-workflow": "2.34.0"
   },
   "peerDependencies": {
     "eslint": "9.29.0",

package/src/rules/no-restricted-globals.test.ts

@@ -70,6 +70,17 @@ var __dirname = '/path';
 const __filename = 'file.js';
 			`,
 		},
+		{
+			name: 'sleep and sleepWithAbort from n8n-workflow should be allowed',
+			code: `
+import { sleep, sleepWithAbort } from 'n8n-workflow';
+
+async function wait(signal) {
+	await sleep(1000);
+	await sleepWithAbort(1000, signal);
+}
+			`,
+		},
 	],
 	invalid: [
 		{
@@ -82,7 +93,12 @@ const __filename = 'file.js';
 		},
 		{
 			code: 'setTimeout(() => {}, 1000);',
-			errors: [{ messageId: 'restrictedGlobal', data: { name: 'setTimeout' } }],
+			errors: [
+				{
+					messageId: 'restrictedGlobalWithHint',
+					data: { name: 'setTimeout', hint: "Use the 'sleep' helper from 'n8n-workflow' instead." },
+				},
+			],
 		},
 		{
 			code: 'clearInterval(timer);',
@@ -90,7 +106,15 @@ const __filename = 'file.js';
 		},
 		{
 			code: 'clearTimeout(timer);',
-			errors: [{ messageId: 'restrictedGlobal', data: { name: 'clearTimeout' } }],
+			errors: [
+				{
+					messageId: 'restrictedGlobalWithHint',
+					data: {
+						name: 'clearTimeout',
+						hint: "Use 'sleepWithAbort' from 'n8n-workflow' with an AbortSignal instead.",
+					},
+				},
+			],
 		},
 		{
 			code: 'setInterval(() => {}, 1000);',

package/src/rules/no-restricted-globals.ts

@@ -17,6 +17,12 @@ const restrictedGlobals = [
 	'__filename',
 ];
 
+// Nudge toward the n8n-workflow alternatives that work under n8n Cloud's restrictions
+const restrictedGlobalHints: Record<string, string> = {
+	setTimeout: "Use the 'sleep' helper from 'n8n-workflow' instead.",
+	clearTimeout: "Use 'sleepWithAbort' from 'n8n-workflow' with an AbortSignal instead.",
+};
+
 export const NoRestrictedGlobalsRule = createRule({
 	name: 'no-restricted-globals',
 	meta: {
@@ -26,6 +32,7 @@ export const NoRestrictedGlobalsRule = createRule({
 		},
 		messages: {
 			restrictedGlobal: "Use of restricted global '{{ name }}' is not allowed",
+			restrictedGlobalWithHint: "Use of restricted global '{{ name }}' is not allowed. {{ hint }}",
 		},
 		schema: [],
 	},
@@ -43,11 +50,21 @@ export const NoRestrictedGlobalsRule = createRule({
 				return;
 			}
 
-			context.report({
-				node: ref.identifier,
-				messageId: 'restrictedGlobal',
-				data: { name },
-			});
+			const hint = restrictedGlobalHints[name];
+
+			context.report(
+				hint
+					? {
+							node: ref.identifier,
+							messageId: 'restrictedGlobalWithHint',
+							data: { name, hint },
+						}
+					: {
+							node: ref.identifier,
+							messageId: 'restrictedGlobal',
+							data: { name },
+						},
+			);
 		}
 
 		return {