@n8n/eslint-plugin-community-nodes 0.24.0 → 0.25.0

package/src/rules/require-param-default.test.ts

@@ -1,227 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { RequireParamDefaultRule } from './require-param-default.js';
-
-const ruleTester = new RuleTester();
-
-function createNodeCode(properties: string): string {
-	return `
-		import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-		export class TestNode implements INodeType {
-			description: INodeTypeDescription = {
-				displayName: 'Test Node',
-				name: 'testNode',
-				group: ['input'],
-				version: 1,
-				description: 'A test node',
-				defaults: { name: 'Test Node' },
-				inputs: [],
-				outputs: [],
-				properties: [
-					${properties}
-				],
-			};
-		}
-	`;
-}
-
-ruleTester.run('require-param-default', RequireParamDefaultRule, {
-	valid: [
-		{
-			name: 'class that does not implement INodeType',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				export class NotANode {
-					description = {
-						properties: [{ displayName: 'Field', name: 'field', type: 'string' }],
-					};
-				}
-			`,
-		},
-		{
-			name: 'param-shaped object outside description (e.g. in a method) is ignored',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-				export class TestNode implements INodeType {
-					description: INodeTypeDescription = {
-						displayName: 'Test Node',
-						name: 'testNode',
-						properties: [],
-					};
-
-					methods = {
-						loadOptions: {
-							async getThings() {
-								const config = { displayName: 'X', name: 'x', type: 'string' };
-								return [config];
-							},
-						},
-					};
-				}
-			`,
-		},
-		{
-			name: 'non .node.ts file is ignored',
-			filename: '/tmp/helper.ts',
-			code: `
-				export class TestNode {
-					description = {
-						properties: [{ displayName: 'Field', name: 'field', type: 'string' }],
-					};
-				}
-			`,
-		},
-		{
-			name: 'string parameter with default',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Field',
-					name: 'field',
-					type: 'string',
-					default: '',
-				},
-			`),
-		},
-		{
-			name: 'options parameter with default',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Operation',
-					name: 'operation',
-					type: 'options',
-					options: [{ name: 'Create', value: 'create' }],
-					default: 'create',
-				},
-			`),
-		},
-		{
-			name: 'notice parameter with empty default',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Some notice',
-					name: 'notice',
-					type: 'notice',
-					default: '',
-				},
-			`),
-		},
-		{
-			name: 'options-array entries (name/value, no displayName) are not parameters',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Operation',
-					name: 'operation',
-					type: 'options',
-					options: [{ name: 'Create', value: 'create', type: 'whatever' }],
-					default: 'create',
-				},
-			`),
-		},
-		{
-			name: 'object with name and type but no displayName is not a parameter',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Routing',
-					name: 'routing',
-					type: 'string',
-					default: '',
-					routing: { request: { method: 'GET', name: 'x', type: 'y' } },
-				},
-			`),
-		},
-		{
-			name: 'nested collection options all have defaults',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Additional Fields',
-					name: 'additionalFields',
-					type: 'collection',
-					default: {},
-					options: [
-						{
-							displayName: 'Limit',
-							name: 'limit',
-							type: 'number',
-							default: 50,
-						},
-					],
-				},
-			`),
-		},
-	],
-	invalid: [
-		{
-			name: 'string parameter missing default',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Field',
-					name: 'field',
-					type: 'string',
-				},
-			`),
-			errors: [{ messageId: 'missingDefault', data: { name: 'field' } }],
-		},
-		{
-			name: 'notice parameter missing default',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Some notice',
-					name: 'notice',
-					type: 'notice',
-				},
-			`),
-			errors: [{ messageId: 'missingDefault', data: { name: 'notice' } }],
-		},
-		{
-			name: 'nested collection option missing default',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'Additional Fields',
-					name: 'additionalFields',
-					type: 'collection',
-					default: {},
-					options: [
-						{
-							displayName: 'Limit',
-							name: 'limit',
-							type: 'number',
-						},
-					],
-				},
-			`),
-			errors: [{ messageId: 'missingDefault', data: { name: 'limit' } }],
-		},
-		{
-			name: 'multiple parameters missing defaults',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				{
-					displayName: 'First',
-					name: 'first',
-					type: 'string',
-				},
-				{
-					displayName: 'Second',
-					name: 'second',
-					type: 'boolean',
-				},
-			`),
-			errors: [
-				{ messageId: 'missingDefault', data: { name: 'first' } },
-				{ messageId: 'missingDefault', data: { name: 'second' } },
-			],
-		},
-	],
-});

package/src/rules/require-param-default.ts

@@ -1,89 +0,0 @@
-/**
- * Requires every node parameter to declare a `default` property.
- *
- * A parameter is detected structurally: an object literal inside a node's
- * `description` with `displayName`, `name`, and `type` all set to string
- * literals — the shape every `INodeProperties` entry has. This avoids
- * hardcoding the `NodePropertyTypes` union (which would silently go stale as
- * new types are added) and naturally excludes `options`-array entries, which
- * carry `name`/`value` but no `displayName`/`type`.
- *
- * Without a `default`, n8n cannot reliably initialise the parameter's value,
- * which leads to inconsistent runtime behaviour in the editor and on execution.
- */
-
-import { simpleTraverse } from '@typescript-eslint/typescript-estree';
-import type { TSESTree } from '@typescript-eslint/utils';
-import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-
-import {
-	createRule,
-	findClassProperty,
-	findObjectProperty,
-	getStringLiteralValue,
-	isFileType,
-	isNodeTypeClass,
-} from '../utils/index.js';
-
-/** Property keys an `INodeProperties` parameter always carries as string literals. */
-const REQUIRED_PARAM_KEYS = ['displayName', 'name', 'type'] as const;
-
-/** Returns true when the object literal has the shape of a node parameter. */
-function isNodeParameter(node: TSESTree.ObjectExpression): boolean {
-	return REQUIRED_PARAM_KEYS.every((key) => {
-		const property = findObjectProperty(node, key);
-		return property !== null && getStringLiteralValue(property.value) !== null;
-	});
-}
-
-export const RequireParamDefaultRule = createRule({
-	name: 'require-param-default',
-	meta: {
-		type: 'problem',
-		docs: {
-			description: 'Require every node parameter to declare a default value.',
-		},
-		messages: {
-			missingDefault:
-				"Node parameter '{{ name }}' is missing a `default` value. Add a `default` property so the parameter initialises consistently.",
-		},
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.node.ts')) {
-			return {};
-		}
-
-		const reportIfMissingDefault = (node: TSESTree.ObjectExpression): void => {
-			if (!isNodeParameter(node) || findObjectProperty(node, 'default') !== null) {
-				return;
-			}
-			const nameProperty = findObjectProperty(node, 'name');
-			context.report({
-				node,
-				messageId: 'missingDefault',
-				data: { name: getStringLiteralValue(nameProperty?.value ?? null) ?? '' },
-			});
-		};
-
-		return {
-			// Scope to an INodeType class's `description`, then walk only that
-			// subtree, so helper classes and object literals elsewhere in the file
-			// (e.g. in method bodies) that share the parameter shape are ignored.
-			ClassDeclaration(node) {
-				if (!isNodeTypeClass(node)) return;
-				const description = findClassProperty(node, 'description');
-				if (description?.value?.type !== AST_NODE_TYPES.ObjectExpression) return;
-
-				simpleTraverse(description.value, {
-					enter(child) {
-						if (child.type === AST_NODE_TYPES.ObjectExpression) {
-							reportIfMissingDefault(child);
-						}
-					},
-				});
-			},
-		};
-	},
-});