@n8n/eslint-plugin-community-nodes 0.36.0 → 0.37.0

package/README.md

@@ -77,6 +77,7 @@ export default [
 | [node-connection-type-literal](docs/rules/node-connection-type-literal.md)               | Disallow string literals in node description `inputs`/`outputs` — use `NodeConnectionTypes` enum instead                                                                               | ✅ ☑️ |      | 🔧 |    |    |
 | [node-registration-complete](docs/rules/node-registration-complete.md)                   | Ensure every `.node.ts` file in the `nodes/` directory is registered in the "n8n.nodes" array of package.json                                                                          |      | ✅ ☑️ |    |    |    |
 | [node-usable-as-tool](docs/rules/node-usable-as-tool.md)                                 | Ensure node classes have usableAsTool property                                                                                                                                         | ✅ ☑️ |      | 🔧 |    |    |
+| [open-ended-node-fields](docs/rules/open-ended-node-fields.md)                           | Discourage optional open-ended JSON fields in node properties                                                                                                                          |      | ✅ ☑️ |    |    |    |
 | [package-name-convention](docs/rules/package-name-convention.md)                         | Enforce correct package naming convention for n8n community nodes                                                                                                                      | ✅ ☑️ |      |    | 💡 |    |
 | [require-files-array](docs/rules/require-files-array.md)                                 | Require a non-empty "files" array in package.json                                                                                                                                      |      | ✅ ☑️ |    |    |    |
 | [require-homepage](docs/rules/require-homepage.md)                                       | Require a "homepage" field with a valid URL in package.json                                                                                                                            |      | ✅ ☑️ |    |    |    |

package/dist/plugin.d.ts

@@ -23,6 +23,7 @@ declare const configs: {
             '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
             '@n8n/community-nodes/no-emoji-in-options': "error";
             '@n8n/community-nodes/node-usable-as-tool': "error";
+            '@n8n/community-nodes/open-ended-node-fields': "warn";
             '@n8n/community-nodes/package-name-convention': "error";
             '@n8n/community-nodes/credential-test-required': "error";
             '@n8n/community-nodes/no-credential-reuse': "error";
@@ -80,6 +81,7 @@ declare const configs: {
             '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
             '@n8n/community-nodes/no-emoji-in-options': "error";
             '@n8n/community-nodes/node-usable-as-tool': "error";
+            '@n8n/community-nodes/open-ended-node-fields': "warn";
             '@n8n/community-nodes/package-name-convention': "error";
             '@n8n/community-nodes/credential-test-required': "error";
             '@n8n/community-nodes/no-credential-reuse': "error";
@@ -148,6 +150,7 @@ declare const pluginWithConfigs: {
                 '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
                 '@n8n/community-nodes/no-emoji-in-options': "error";
                 '@n8n/community-nodes/node-usable-as-tool': "error";
+                '@n8n/community-nodes/open-ended-node-fields': "warn";
                 '@n8n/community-nodes/package-name-convention': "error";
                 '@n8n/community-nodes/credential-test-required': "error";
                 '@n8n/community-nodes/no-credential-reuse': "error";
@@ -205,6 +208,7 @@ declare const pluginWithConfigs: {
                 '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
                 '@n8n/community-nodes/no-emoji-in-options': "error";
                 '@n8n/community-nodes/node-usable-as-tool': "error";
+                '@n8n/community-nodes/open-ended-node-fields': "warn";
                 '@n8n/community-nodes/package-name-convention': "error";
                 '@n8n/community-nodes/credential-test-required': "error";
                 '@n8n/community-nodes/no-credential-reuse': "error";
@@ -274,6 +278,7 @@ declare const n8nCommunityNodesPlugin: {
                 '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
                 '@n8n/community-nodes/no-emoji-in-options': "error";
                 '@n8n/community-nodes/node-usable-as-tool': "error";
+                '@n8n/community-nodes/open-ended-node-fields': "warn";
                 '@n8n/community-nodes/package-name-convention': "error";
                 '@n8n/community-nodes/credential-test-required': "error";
                 '@n8n/community-nodes/no-credential-reuse': "error";
@@ -331,6 +336,7 @@ declare const n8nCommunityNodesPlugin: {
                 '@n8n/community-nodes/no-deprecated-workflow-functions': "error";
                 '@n8n/community-nodes/no-emoji-in-options': "error";
                 '@n8n/community-nodes/node-usable-as-tool': "error";
+                '@n8n/community-nodes/open-ended-node-fields': "warn";
                 '@n8n/community-nodes/package-name-convention': "error";
                 '@n8n/community-nodes/credential-test-required': "error";
                 '@n8n/community-nodes/no-credential-reuse': "error";

package/dist/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAG7C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAYzC,QAAA,MAAM,OAAO;;;;YAIV,sBAAsB;;oBAZvB,IAAI;oBACJ,OAAO;oBACP,SAAS;;uBAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA2DpC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+CgB,CAAC;AAE1C,QAAA,MAAM,iBAAiB;;QAjHrB,IAAI;QACJ,OAAO;QACP,SAAS;;WAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;gBAOpC,sBAAsB;;wBAZvB,IAAI;wBACJ,OAAO;wBACP,SAAS;;2BAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA2DpC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiD+C,CAAC;AAEzE,QAAA,MAAM,uBAAuB;;QAnH3B,IAAI;QACJ,OAAO;QACP,SAAS;;WAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;gBAOpC,sBAAsB;;wBAZvB,IAAI;wBACJ,OAAO;wBACP,SAAS;;2BAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA2DpC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmDwB,CAAC;eACnC,iBAAiB;AAChC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAG7C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAYzC,QAAA,MAAM,OAAO;;;;YAIV,sBAAsB;;oBAZvB,IAAI;oBACJ,OAAO;oBACP,SAAS;;uBAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA4DpC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgDgB,CAAC;AAE1C,QAAA,MAAM,iBAAiB;;QAnHrB,IAAI;QACJ,OAAO;QACP,SAAS;;WAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;gBAOpC,sBAAsB;;wBAZvB,IAAI;wBACJ,OAAO;wBACP,SAAS;;2BAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA4DpC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkD+C,CAAC;AAEzE,QAAA,MAAM,uBAAuB;;QArH3B,IAAI;QACJ,OAAO;QACP,SAAS;;WAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;gBAOpC,sBAAsB;;wBAZvB,IAAI;wBACJ,OAAO;wBACP,SAAS;;2BAGM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBA4DpC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoDwB,CAAC;eACnC,iBAAiB;AAChC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/plugin.js

@@ -25,6 +25,7 @@ const configs = {
             '@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
             '@n8n/community-nodes/no-emoji-in-options': 'error',
             '@n8n/community-nodes/node-usable-as-tool': 'error',
+            '@n8n/community-nodes/open-ended-node-fields': 'warn',
             '@n8n/community-nodes/package-name-convention': 'error',
             '@n8n/community-nodes/credential-test-required': 'error',
             '@n8n/community-nodes/no-credential-reuse': 'error',
@@ -75,6 +76,7 @@ const configs = {
             '@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
             '@n8n/community-nodes/no-emoji-in-options': 'error',
             '@n8n/community-nodes/node-usable-as-tool': 'error',
+            '@n8n/community-nodes/open-ended-node-fields': 'warn',
             '@n8n/community-nodes/package-name-convention': 'error',
             '@n8n/community-nodes/credential-test-required': 'error',
             '@n8n/community-nodes/no-credential-reuse': 'error',

package/dist/rules/index.d.ts

@@ -20,6 +20,9 @@ export declare const rules: {
     'node-usable-as-tool': import("@typescript-eslint/utils/ts-eslint").RuleModule<"aiOnlyUsableAsTool" | "missingUsableAsTool" | "triggerUsableAsTool", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
         name: string;
     };
+    'open-ended-node-fields': import("@typescript-eslint/utils/ts-eslint").RuleModule<"optionalJson", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+        name: string;
+    };
     'package-name-convention': import("@typescript-eslint/utils/ts-eslint").RuleModule<"defaultPlaceholderName" | "invalidPackageName" | "missingName" | "renameTo", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
         name: string;
     };

package/dist/rules/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAgDA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8CuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAiDA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+CuB,CAAC"}

package/dist/rules/index.js

@@ -29,6 +29,7 @@ import { NodeClassDescriptionIconMissingRule } from './node-class-description-ic
 import { NodeConnectionTypeLiteralRule } from './node-connection-type-literal.js';
 import { NodeRegistrationCompleteRule } from './node-registration-complete.js';
 import { NodeUsableAsToolRule } from './node-usable-as-tool.js';
+import { OpenEndedNodeFieldsRule } from './open-ended-node-fields.js';
 import { PackageNameConventionRule } from './package-name-convention.js';
 import { RequireFilesArrayRule } from './require-files-array.js';
 import { RequireHomepageRule } from './require-homepage.js';
@@ -51,6 +52,7 @@ export const rules = {
     'no-deprecated-workflow-functions': NoDeprecatedWorkflowFunctionsRule,
     'no-emoji-in-options': NoEmojiInOptionsRule,
     'node-usable-as-tool': NodeUsableAsToolRule,
+    'open-ended-node-fields': OpenEndedNodeFieldsRule,
     'package-name-convention': PackageNameConventionRule,
     'credential-test-required': CredentialTestRequiredRule,
     'credential-unnecessary-password': CredentialUnnecessaryPasswordRule,

package/dist/rules/open-ended-node-fields.d.ts

@@ -0,0 +1,4 @@
+export declare const OpenEndedNodeFieldsRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"optionalJson", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+    name: string;
+};
+//# sourceMappingURL=open-ended-node-fields.d.ts.map

package/dist/rules/open-ended-node-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-ended-node-fields.d.ts","sourceRoot":"","sources":["../../src/rules/open-ended-node-fields.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,uBAAuB;;CAyClC,CAAC"}

package/dist/rules/open-ended-node-fields.js

@@ -0,0 +1,44 @@
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { createRule, findArrayLiteralProperty, findNodeDescriptionObject, findObjectProperty, getBooleanLiteralValue, getStringLiteralValue, isFileType, isNodeTypeClass, } from '../utils/index.js';
+export const OpenEndedNodeFieldsRule = createRule({
+    name: 'open-ended-node-fields',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Discourage optional open-ended JSON fields in node properties',
+        },
+        messages: {
+            optionalJson: 'Optional JSON fields can hide configuration. Use typed parameters under Additional Options or Additional Fields instead.',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        if (!isFileType(context.filename, '.node.ts'))
+            return {};
+        return {
+            ClassDeclaration(node) {
+                if (!isNodeTypeClass(node))
+                    return;
+                const description = findNodeDescriptionObject(node);
+                if (!description)
+                    return;
+                const properties = findArrayLiteralProperty(description, 'properties');
+                if (!properties)
+                    return;
+                for (const property of properties.elements) {
+                    if (property?.type !== AST_NODE_TYPES.ObjectExpression)
+                        continue;
+                    const type = findObjectProperty(property, 'type');
+                    if (getStringLiteralValue(type?.value ?? null) !== 'json')
+                        continue;
+                    const required = findObjectProperty(property, 'required');
+                    if (getBooleanLiteralValue(required?.value ?? null) === true)
+                        continue;
+                    context.report({ node: property, messageId: 'optionalJson' });
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=open-ended-node-fields.js.map

package/docs/rules/open-ended-node-fields.md

@@ -0,0 +1,35 @@
+# Discourage optional open-ended JSON fields in node properties (`@n8n/community-nodes/open-ended-node-fields`)
+
+⚠️ This rule _warns_ in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+This rule warns about optional top-level JSON properties in node descriptions. A JSON configuration field can hide parameters from the editor. Typed parameters make configuration easier to find, validate, and change.
+
+Place optional parameters under Additional Options or Additional Fields. The rule does not report required JSON properties or typed collection options.
+
+## Examples
+
+### Incorrect
+
+```typescript
+properties: [
+	{ displayName: 'Configuration', name: 'configuration', type: 'json', default: '{}' },
+];
+```
+
+### Correct
+
+```typescript
+properties: [
+	{
+		displayName: 'Additional Fields',
+		name: 'additionalFields',
+		type: 'collection',
+		default: {},
+		options: [{ displayName: 'Limit', name: 'limit', type: 'number', default: 10 }],
+	},
+];
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@n8n/eslint-plugin-community-nodes",
   "type": "module",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "main": "./dist/plugin.js",
   "types": "./dist/plugin.d.ts",
   "exports": {
@@ -11,7 +11,7 @@
     }
   },
   "dependencies": {
-    "@n8n/utils": "1.51.0",
+    "@n8n/utils": "1.52.0",
     "@typescript-eslint/typescript-estree": "8.70.0",
     "@typescript-eslint/utils": "8.70.0",
     "fastest-levenshtein": "1.0.16"
@@ -20,7 +20,7 @@
     "@n8n/typescript-config": "1.12.0",
     "@n8n/vitest-config": "1.24.0",
     "@types/node": "24.10.1",
-    "n8n-workflow": "2.44.0",
+    "n8n-workflow": "2.45.0",
     "@typescript-eslint/rule-tester": "8.70.0",
     "eslint-doc-generator": "^2.2.2",
     "eslint-plugin-eslint-plugin": "^7.0.0",

package/src/plugin.ts

@@ -29,6 +29,7 @@ const configs = {
 			'@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
 			'@n8n/community-nodes/no-emoji-in-options': 'error',
 			'@n8n/community-nodes/node-usable-as-tool': 'error',
+			'@n8n/community-nodes/open-ended-node-fields': 'warn',
 			'@n8n/community-nodes/package-name-convention': 'error',
 			'@n8n/community-nodes/credential-test-required': 'error',
 			'@n8n/community-nodes/no-credential-reuse': 'error',
@@ -79,6 +80,7 @@ const configs = {
 			'@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
 			'@n8n/community-nodes/no-emoji-in-options': 'error',
 			'@n8n/community-nodes/node-usable-as-tool': 'error',
+			'@n8n/community-nodes/open-ended-node-fields': 'warn',
 			'@n8n/community-nodes/package-name-convention': 'error',
 			'@n8n/community-nodes/credential-test-required': 'error',
 			'@n8n/community-nodes/no-credential-reuse': 'error',

package/src/rules/index.ts

@@ -31,6 +31,7 @@ import { NodeClassDescriptionIconMissingRule } from './node-class-description-ic
 import { NodeConnectionTypeLiteralRule } from './node-connection-type-literal.js';
 import { NodeRegistrationCompleteRule } from './node-registration-complete.js';
 import { NodeUsableAsToolRule } from './node-usable-as-tool.js';
+import { OpenEndedNodeFieldsRule } from './open-ended-node-fields.js';
 import { PackageNameConventionRule } from './package-name-convention.js';
 import { RequireFilesArrayRule } from './require-files-array.js';
 import { RequireHomepageRule } from './require-homepage.js';
@@ -54,6 +55,7 @@ export const rules = {
 	'no-deprecated-workflow-functions': NoDeprecatedWorkflowFunctionsRule,
 	'no-emoji-in-options': NoEmojiInOptionsRule,
 	'node-usable-as-tool': NodeUsableAsToolRule,
+	'open-ended-node-fields': OpenEndedNodeFieldsRule,
 	'package-name-convention': PackageNameConventionRule,
 	'credential-test-required': CredentialTestRequiredRule,
 	'credential-unnecessary-password': CredentialUnnecessaryPasswordRule,

package/src/rules/open-ended-node-fields.test.ts

@@ -0,0 +1,122 @@
+import { Linter } from 'eslint';
+import { describe, expect, it } from 'vitest';
+
+import { configs } from '../plugin.js';
+
+const linter = new Linter();
+
+function createNodeCode(property: string): string {
+	return `
+export class TestNode extends Node {
+	description = {
+		displayName: 'Test Node',
+		name: 'testNode',
+		group: ['transform'],
+		version: 1,
+		inputs: ['main'],
+		outputs: ['main'],
+		properties: [${property}],
+	};
+}`;
+}
+
+function lintNode(code: string, config: keyof typeof configs) {
+	return linter.verify(code, [{ ...configs[config], files: ['**/*.node.ts'] }], {
+		filename: 'src/rules/TestNode.node.ts',
+	});
+}
+
+describe.each(['recommended', 'recommendedWithoutN8nCloudSupport'] as const)(
+	'%s node property review',
+	(config) => {
+		// CE-1879: Warn when an optional JSON field replaces typed node parameters.
+		it('warns about an optional JSON configuration catch-all', () => {
+			const code = createNodeCode(`{
+				displayName: 'Configuration',
+				name: 'configuration',
+				type: 'json',
+				required: false,
+				default: '{}',
+			}`);
+
+			const warnings = lintNode(code, config).filter(
+				({ severity, message }) => severity === 1 && /Additional (Options|Fields)/i.test(message),
+			);
+
+			expect(warnings).toEqual([
+				expect.objectContaining({
+					severity: 1,
+					message: expect.stringMatching(/Additional (Options|Fields)/i),
+				}),
+			]);
+		});
+
+		it('does not warn about typed parameters inside Additional Fields', () => {
+			const code = createNodeCode(`{
+				displayName: 'Additional Fields',
+				name: 'additionalFields',
+				type: 'collection',
+				default: {},
+				options: [{ displayName: 'Limit', name: 'limit', type: 'number', default: 10 }],
+			}`);
+
+			const messages = lintNode(code, config);
+			expect(messages).toEqual(
+				expect.arrayContaining([
+					expect.objectContaining({
+						ruleId: '@n8n/community-nodes/require-node-description-fields',
+					}),
+				]),
+			);
+
+			const warnings = messages.filter(
+				({ severity, message }) => severity === 1 && /Additional (Options|Fields)/i.test(message),
+			);
+
+			expect(warnings).toEqual([]);
+		});
+
+		it('warns when an open-ended JSON field does not declare required', () => {
+			const code = createNodeCode(`{
+				displayName: 'Configuration',
+				name: 'configuration',
+				type: 'json',
+				default: '{}',
+			}`);
+
+			expect(
+				lintNode(code, config).filter(
+					({ ruleId }) => ruleId === '@n8n/community-nodes/open-ended-node-fields',
+				),
+			).toHaveLength(1);
+		});
+
+		it('does not warn about required JSON fields', () => {
+			const code = createNodeCode(`{
+				displayName: 'Request Body',
+				name: 'body',
+				type: 'json',
+				required: true,
+				default: '{}',
+			}`);
+
+			expect(
+				lintNode(code, config).filter(
+					({ ruleId }) => ruleId === '@n8n/community-nodes/open-ended-node-fields',
+				),
+			).toEqual([]);
+		});
+
+		it('does not inspect classes that are not nodes', () => {
+			const code = `class Helper {
+				description = { properties: [{ type: 'json', required: false }] };
+			}`;
+
+			expect(
+				lintNode(code, config).filter(
+					({ ruleId }) => ruleId === '@n8n/community-nodes/open-ended-node-fields',
+				),
+			).toEqual([]);
+		});
+	},
+);

package/src/rules/open-ended-node-fields.ts

@@ -0,0 +1,55 @@
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+
+import {
+	createRule,
+	findArrayLiteralProperty,
+	findNodeDescriptionObject,
+	findObjectProperty,
+	getBooleanLiteralValue,
+	getStringLiteralValue,
+	isFileType,
+	isNodeTypeClass,
+} from '../utils/index.js';
+
+export const OpenEndedNodeFieldsRule = createRule({
+	name: 'open-ended-node-fields',
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Discourage optional open-ended JSON fields in node properties',
+		},
+		messages: {
+			optionalJson:
+				'Optional JSON fields can hide configuration. Use typed parameters under Additional Options or Additional Fields instead.',
+		},
+		schema: [],
+	},
+	defaultOptions: [],
+	create(context) {
+		if (!isFileType(context.filename, '.node.ts')) return {};
+
+		return {
+			ClassDeclaration(node) {
+				if (!isNodeTypeClass(node)) return;
+
+				const description = findNodeDescriptionObject(node);
+				if (!description) return;
+
+				const properties = findArrayLiteralProperty(description, 'properties');
+				if (!properties) return;
+
+				for (const property of properties.elements) {
+					if (property?.type !== AST_NODE_TYPES.ObjectExpression) continue;
+
+					const type = findObjectProperty(property, 'type');
+					if (getStringLiteralValue(type?.value ?? null) !== 'json') continue;
+
+					const required = findObjectProperty(property, 'required');
+					if (getBooleanLiteralValue(required?.value ?? null) === true) continue;
+
+					context.report({ node: property, messageId: 'optionalJson' });
+				}
+			},
+		};
+	},
+});