@n8n/eslint-plugin-community-nodes 0.29.0 → 0.30.0

package/dist/rules/node-registration-complete.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node-registration-complete.d.ts","sourceRoot":"","sources":["../../src/rules/node-registration-complete.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,4BAA4B,sJAqDvC,CAAC"}
+{"version":3,"file":"node-registration-complete.d.ts","sourceRoot":"","sources":["../../src/rules/node-registration-complete.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,4BAA4B,sJAkEvC,CAAC"}

package/dist/rules/node-registration-complete.js

@@ -1,6 +1,6 @@
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 import * as path from 'node:path';
-import { createRule, findJsonProperty, findNodeSourceFilesOnDisk, readPackageJsonNodes, } from '../utils/index.js';
+import { createRule, findJsonProperty, findNodeSourceFilesOnDisk, isContainedWithin, readPackageJsonNodes, } from '../utils/index.js';
 export const NodeRegistrationCompleteRule = createRule({
     name: 'node-registration-complete',
     meta: {
@@ -28,11 +28,23 @@ export const NodeRegistrationCompleteRule = createRule({
                 if (nodeFilesOnDisk.length === 0) {
                     return;
                 }
-                const registered = new Set(readPackageJsonNodes(context.filename).map((filePath) => path.resolve(filePath)));
+                const registeredFiles = readPackageJsonNodes(context.filename).map((filePath) => path.resolve(filePath));
+                const registered = new Set(registeredFiles);
+                // Directories of registered entry files, used to recognise versioned
+                // nodes: a `VersionedNodeType` entry file (e.g. `SoterGuard.node.ts`) is
+                // registered, and its per-version implementations live in subdirectories
+                // (e.g. `v1/SoterGuardV1.node.ts`) pulled in by that entry file.
+                const registeredDirs = registeredFiles.map((filePath) => path.dirname(filePath));
                 const packageDir = path.dirname(context.filename);
                 const reportTarget = resolveReportTarget(node);
                 for (const nodeFile of nodeFilesOnDisk) {
-                    if (registered.has(path.resolve(nodeFile))) {
+                    const resolvedNodeFile = path.resolve(nodeFile);
+                    if (registered.has(resolvedNodeFile)) {
+                        continue;
+                    }
+                    // Skip per-version implementation files nested under a registered
+                    // versioned node's entry directory.
+                    if (isRegisteredThroughVersionedEntry(resolvedNodeFile, registeredDirs)) {
                         continue;
                     }
                     context.report({
@@ -45,6 +57,17 @@ export const NodeRegistrationCompleteRule = createRule({
         };
     },
 });
+/**
+ * Determines whether a node file is a per-version implementation of a registered
+ * versioned node. Such files sit in a subdirectory of the registered
+ * `VersionedNodeType` entry file (e.g. `SoterGuard/v1/SoterGuardV1.node.ts` under
+ * the entry `SoterGuard/SoterGuard.node.ts`), so they are discovered through the
+ * entry file rather than being listed individually in `n8n.nodes`.
+ */
+function isRegisteredThroughVersionedEntry(nodeFile, registeredDirs) {
+    const nodeDir = path.dirname(nodeFile);
+    return registeredDirs.some((registeredDir) => registeredDir !== nodeDir && isContainedWithin(registeredDir, nodeDir));
+}
 /**
  * Reports against the most specific available node: the `n8n.nodes` array, the
  * `n8n` object, or the package.json root object as a fallback.

package/dist/rules/node-registration-complete.js.map

@@ -1 +1 @@
-{"version":3,"file":"node-registration-complete.js","sourceRoot":"","sources":["../../src/rules/node-registration-complete.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EACN,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,oBAAoB,GACpB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,CAAC,MAAM,4BAA4B,GAAG,UAAU,CAAC;IACtD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EACV,+GAA+G;SAChH;QACD,QAAQ,EAAE;YACT,iBAAiB,EAChB,iIAAiI;SAClI;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChD,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAA+B;gBAC/C,yDAAyD;gBACzD,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;oBAC9D,OAAO;gBACR,CAAC;gBAED,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACpE,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO;gBACR,CAAC;gBAED,MAAM,UAAU,GAAG,IAAI,GAAG,CACzB,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAChF,CAAC;gBAEF,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAClD,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAE/C,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;oBACxC,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;wBAC5C,SAAS;oBACV,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,YAAY;wBAClB,SAAS,EAAE,mBAAmB;wBAC9B,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE;qBACvD,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC;AAEH;;;GAGG;AACH,SAAS,mBAAmB,CAAC,IAA+B;IAC3D,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClD,IAAI,WAAW,EAAE,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QACjE,OAAO,WAAW,IAAI,IAAI,CAAC;IAC5B,CAAC;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,OAAO,aAAa,IAAI,WAAW,CAAC;AACrC,CAAC"}
+{"version":3,"file":"node-registration-complete.js","sourceRoot":"","sources":["../../src/rules/node-registration-complete.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EACN,UAAU,EACV,gBAAgB,EAChB,yBAAyB,EACzB,iBAAiB,EACjB,oBAAoB,GACpB,MAAM,mBAAmB,CAAC;AAE3B,MAAM,CAAC,MAAM,4BAA4B,GAAG,UAAU,CAAC;IACtD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EACV,+GAA+G;SAChH;QACD,QAAQ,EAAE;YACT,iBAAiB,EAChB,iIAAiI;SAClI;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChD,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAA+B;gBAC/C,yDAAyD;gBACzD,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;oBAC9D,OAAO;gBACR,CAAC;gBAED,MAAM,eAAe,GAAG,yBAAyB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACpE,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO;gBACR,CAAC;gBAED,MAAM,eAAe,GAAG,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC/E,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CACtB,CAAC;gBACF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC5C,qEAAqE;gBACrE,yEAAyE;gBACzE,yEAAyE;gBACzE,iEAAiE;gBACjE,MAAM,cAAc,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAEjF,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAClD,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAE/C,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE,CAAC;oBACxC,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAChD,IAAI,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC;wBACtC,SAAS;oBACV,CAAC;oBAED,kEAAkE;oBAClE,oCAAoC;oBACpC,IAAI,iCAAiC,CAAC,gBAAgB,EAAE,cAAc,CAAC,EAAE,CAAC;wBACzE,SAAS;oBACV,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,YAAY;wBAClB,SAAS,EAAE,mBAAmB;wBAC9B,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE;qBACvD,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,SAAS,iCAAiC,CAAC,QAAgB,EAAE,cAAwB;IACpF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvC,OAAO,cAAc,CAAC,IAAI,CACzB,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,KAAK,OAAO,IAAI,iBAAiB,CAAC,aAAa,EAAE,OAAO,CAAC,CACzF,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,IAA+B;IAC3D,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClD,IAAI,WAAW,EAAE,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QACjE,OAAO,WAAW,IAAI,IAAI,CAAC;IAC5B,CAAC;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,OAAO,aAAa,IAAI,WAAW,CAAC;AACrC,CAAC"}

package/docs/rules/node-registration-complete.md

@@ -44,3 +44,29 @@ Every node file is registered:
   }
 }
 ```
+
+### Versioned nodes
+
+A versioned node registers only its `VersionedNodeType` entry file. Its per-version
+implementations live in subdirectories of that entry file and are pulled in by it, so
+they must **not** be listed individually in `n8n.nodes`. The rule recognises this and
+does not flag the version files.
+
+Given:
+
+```
+nodes/SoterGuard/SoterGuard.node.ts
+nodes/SoterGuard/v1/SoterGuardV1.node.ts
+nodes/SoterGuard/v2/SoterGuardV2.node.ts
+```
+
+registering just the entry file is correct:
+
+```json
+{
+  "name": "n8n-nodes-my-service",
+  "n8n": {
+    "nodes": ["dist/nodes/SoterGuard/SoterGuard.node.js"]
+  }
+}
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@n8n/eslint-plugin-community-nodes",
   "type": "module",
-  "version": "0.29.0",
+  "version": "0.30.0",
   "main": "./dist/plugin.js",
   "types": "./dist/plugin.d.ts",
   "exports": {
@@ -25,9 +25,9 @@
     "typescript": "npm:@typescript/typescript6@6.0.2",
     "vite": "^8.0.2",
     "vitest": "^4.1.9",
-    "@n8n/typescript-config": "1.9.0",
-    "@n8n/vitest-config": "1.20.0",
-    "n8n-workflow": "2.35.0"
+    "@n8n/typescript-config": "1.10.0",
+    "@n8n/vitest-config": "1.21.0",
+    "n8n-workflow": "2.37.0"
   },
   "peerDependencies": {
     "eslint": "9.29.0",

package/src/rules/node-registration-complete.test.ts

@@ -20,6 +20,16 @@ const packageJsonPath = '/tmp/package.json';
 const fooNode = '/tmp/nodes/Foo/Foo.node.ts';
 const barNode = '/tmp/nodes/Bar/Bar.node.ts';
 
+// Versioned node: the v1/v2 implementations sit behind a `VersionedNodeType`
+// entry file, and only that entry file is listed in `n8n.nodes`.
+const versionedEntryNode = '/tmp/nodes/SoterGuard/SoterGuard.node.ts';
+const versionedV1Node = '/tmp/nodes/SoterGuard/v1/SoterGuardV1.node.ts';
+const versionedV2Node = '/tmp/nodes/SoterGuard/v2/SoterGuardV2.node.ts';
+
+// A sibling node file in the same directory as a registered node (not nested in a
+// version subdirectory) is not a versioned implementation and must still be flagged.
+const fooSiblingNode = '/tmp/nodes/Foo/FooExtra.node.ts';
+
 const ruleTester = new RuleTester();
 
 function setup(onDisk: string[], registered: string[]): void {
@@ -46,6 +56,17 @@ ruleTester.run('node-registration-complete', NodeRegistrationCompleteRule, {
 			filename: 'some-config.json',
 			code: '{ "name": "n8n-nodes-example" }',
 		},
+		{
+			// A versioned node registers only its `VersionedNodeType` entry file in
+			// `n8n.nodes`; the per-version implementation files (v1/v2) are pulled in
+			// by that entry file and must not be flagged as unregistered.
+			name: 'versioned node registered via its entry file does not flag its version implementations',
+			filename: packageJsonPath,
+			code: '{ "name": "n8n-nodes-example", "n8n": { "nodes": ["dist/nodes/SoterGuard/SoterGuard.node.js"] } }',
+			before() {
+				setup([versionedEntryNode, versionedV1Node, versionedV2Node], [versionedEntryNode]);
+			},
+		},
 	],
 	invalid: [
 		{
@@ -74,6 +95,20 @@ ruleTester.run('node-registration-complete', NodeRegistrationCompleteRule, {
 				{ messageId: 'nodeNotRegistered', data: { nodeFile: 'nodes/Bar/Bar.node.ts' } },
 			],
 		},
+		{
+			// The unregistered file sits directly beside a registered node, not in a
+			// version subdirectory, so it is not covered by the versioned-node entry
+			// and must still be reported.
+			name: 'unregistered sibling in a registered node directory is still flagged',
+			filename: packageJsonPath,
+			code: '{ "name": "n8n-nodes-example", "n8n": { "nodes": ["dist/nodes/Foo/Foo.node.js"] } }',
+			before() {
+				setup([fooNode, fooSiblingNode], [fooNode]);
+			},
+			errors: [
+				{ messageId: 'nodeNotRegistered', data: { nodeFile: 'nodes/Foo/FooExtra.node.ts' } },
+			],
+		},
 		{
 			name: 'node files exist on disk but there is no n8n object',
 			filename: packageJsonPath,

package/src/rules/node-registration-complete.ts

@@ -6,6 +6,7 @@ import {
 	createRule,
 	findJsonProperty,
 	findNodeSourceFilesOnDisk,
+	isContainedWithin,
 	readPackageJsonNodes,
 } from '../utils/index.js';
 
@@ -41,15 +42,28 @@ export const NodeRegistrationCompleteRule = createRule({
 					return;
 				}
 
-				const registered = new Set(
-					readPackageJsonNodes(context.filename).map((filePath) => path.resolve(filePath)),
+				const registeredFiles = readPackageJsonNodes(context.filename).map((filePath) =>
+					path.resolve(filePath),
 				);
+				const registered = new Set(registeredFiles);
+				// Directories of registered entry files, used to recognise versioned
+				// nodes: a `VersionedNodeType` entry file (e.g. `SoterGuard.node.ts`) is
+				// registered, and its per-version implementations live in subdirectories
+				// (e.g. `v1/SoterGuardV1.node.ts`) pulled in by that entry file.
+				const registeredDirs = registeredFiles.map((filePath) => path.dirname(filePath));
 
 				const packageDir = path.dirname(context.filename);
 				const reportTarget = resolveReportTarget(node);
 
 				for (const nodeFile of nodeFilesOnDisk) {
-					if (registered.has(path.resolve(nodeFile))) {
+					const resolvedNodeFile = path.resolve(nodeFile);
+					if (registered.has(resolvedNodeFile)) {
+						continue;
+					}
+
+					// Skip per-version implementation files nested under a registered
+					// versioned node's entry directory.
+					if (isRegisteredThroughVersionedEntry(resolvedNodeFile, registeredDirs)) {
 						continue;
 					}
 
@@ -64,6 +78,20 @@ export const NodeRegistrationCompleteRule = createRule({
 	},
 });
 
+/**
+ * Determines whether a node file is a per-version implementation of a registered
+ * versioned node. Such files sit in a subdirectory of the registered
+ * `VersionedNodeType` entry file (e.g. `SoterGuard/v1/SoterGuardV1.node.ts` under
+ * the entry `SoterGuard/SoterGuard.node.ts`), so they are discovered through the
+ * entry file rather than being listed individually in `n8n.nodes`.
+ */
+function isRegisteredThroughVersionedEntry(nodeFile: string, registeredDirs: string[]): boolean {
+	const nodeDir = path.dirname(nodeFile);
+	return registeredDirs.some(
+		(registeredDir) => registeredDir !== nodeDir && isContainedWithin(registeredDir, nodeDir),
+	);
+}
+
 /**
  * Reports against the most specific available node: the `n8n.nodes` array, the
  * `n8n` object, or the package.json root object as a fallback.

package/.turbo/turbo-build.log

@@ -1,4 +0,0 @@
-
-> @n8n/eslint-plugin-community-nodes@0.29.0 build /home/runner/work/n8n/n8n/packages/@n8n/eslint-plugin-community-nodes
-> tsc --project tsconfig.build.json
-