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

package/src/rules/options-sorted-alphabetically.test.ts

@@ -1,468 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { OptionsSortedAlphabeticallyRule } from './options-sorted-alphabetically.js';
-
-const ruleTester = new RuleTester();
-
-ruleTester.run('options-sorted-alphabetically', OptionsSortedAlphabeticallyRule, {
-	valid: [
-		{
-			name: 'resource options already sorted alphabetically',
-			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: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'Contact', value: 'contact' },
-									{ name: 'Project', value: 'project' },
-									{ name: 'User', value: 'user' },
-								],
-								default: 'contact',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'operation options already sorted alphabetically',
-			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: [
-							{
-								displayName: 'Operation',
-								name: 'operation',
-								type: 'options',
-								options: [
-									{ name: 'Create', value: 'create' },
-									{ name: 'Delete', value: 'delete' },
-									{ name: 'Get', value: 'get' },
-									{ name: 'Update', value: 'update' },
-								],
-								default: 'get',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'non-ASCII names sorted correctly via localeCompare',
-			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: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'Árbol', value: 'arbol' },
-									{ name: 'Empresa', value: 'empresa' },
-									{ name: 'Usuario', value: 'usuario' },
-								],
-								default: 'arbol',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'single option is trivially sorted',
-			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: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'User', value: 'user' },
-								],
-								default: 'user',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'non-options type parameter 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: [
-							{
-								displayName: 'Name',
-								name: 'name',
-								type: 'string',
-								default: '',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'non-node class is ignored',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				export class NotANode {
-					description = {
-						properties: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'User', value: 'user' },
-									{ name: 'Contact', value: 'contact' },
-								],
-								default: 'user',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'non-.node.ts file is ignored',
-			filename: '/tmp/TestHelper.ts',
-			code: `
-				import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-				export class TestNode implements INodeType {
-					description: INodeTypeDescription = {
-						displayName: 'Test Node',
-						name: 'testNode',
-						properties: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'User', value: 'user' },
-									{ name: 'Contact', value: 'contact' },
-								],
-								default: 'user',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'description assigned from a variable is skipped',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-				const desc: INodeTypeDescription = {} as INodeTypeDescription;
-
-				export class TestNode implements INodeType {
-					description = desc;
-				}
-			`,
-		},
-		{
-			name: 'node with no properties array is skipped',
-			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',
-					};
-				}
-			`,
-		},
-		{
-			name: 'spread element in properties array is skipped gracefully',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-				const extraProps = [{ displayName: 'Extra', name: 'extra', type: 'string', default: '' }];
-
-				export class TestNode implements INodeType {
-					description: INodeTypeDescription = {
-						displayName: 'Test Node',
-						name: 'testNode',
-						properties: [
-							...extraProps,
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'options with a spread element are skipped (dynamic options)',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-				const extraOption = { name: 'Extra', value: 'extra' };
-
-				export class TestNode implements INodeType {
-					description: INodeTypeDescription = {
-						displayName: 'Test Node',
-						name: 'testNode',
-						properties: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'User', value: 'user' },
-									...([extraOption]),
-								],
-								default: 'user',
-							},
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'options with a dynamic name value are skipped',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-				const dynamicName = 'Dynamic';
-
-				export class TestNode implements INodeType {
-					description: INodeTypeDescription = {
-						displayName: 'Test Node',
-						name: 'testNode',
-						properties: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: dynamicName, value: 'dynamic' },
-									{ name: 'User', value: 'user' },
-								],
-								default: 'user',
-							},
-						],
-					};
-				}
-			`,
-		},
-	],
-	invalid: [
-		{
-			name: 'resource options not sorted alphabetically',
-			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: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'User', value: 'user' },
-									{ name: 'Contact', value: 'contact' },
-									{ name: 'Project', value: 'project' },
-								],
-								default: 'user',
-							},
-						],
-					};
-				}
-			`,
-			errors: [
-				{
-					messageId: 'optionsNotSorted',
-					data: { displayName: 'Resource', expectedOrder: 'Contact, Project, User' },
-				},
-			],
-		},
-		{
-			name: 'operation options not sorted alphabetically',
-			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: [
-							{
-								displayName: 'Operation',
-								name: 'operation',
-								type: 'options',
-								options: [
-									{ name: 'Update', value: 'update' },
-									{ name: 'Create', value: 'create' },
-									{ name: 'Delete', value: 'delete' },
-									{ name: 'Get', value: 'get' },
-								],
-								default: 'get',
-							},
-						],
-					};
-				}
-			`,
-			errors: [
-				{
-					messageId: 'optionsNotSorted',
-					data: { displayName: 'Operation', expectedOrder: 'Create, Delete, Get, Update' },
-				},
-			],
-		},
-		{
-			name: 'other options-type parameter not sorted alphabetically',
-			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: [
-							{
-								displayName: 'Model',
-								name: 'model',
-								type: 'options',
-								options: [
-									{ name: 'GPT-4', value: 'gpt-4' },
-									{ name: 'Claude', value: 'claude' },
-									{ name: 'Gemini', value: 'gemini' },
-								],
-								default: 'gpt-4',
-							},
-						],
-					};
-				}
-			`,
-			errors: [
-				{
-					messageId: 'optionsNotSorted',
-					data: { displayName: 'Model', expectedOrder: 'Claude, Gemini, GPT-4' },
-				},
-			],
-		},
-		{
-			name: 'options-type parameter without displayName falls back to "unknown"',
-			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: [
-							{
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'User', value: 'user' },
-									{ name: 'Contact', value: 'contact' },
-								],
-								default: 'user',
-							},
-						],
-					};
-				}
-			`,
-			errors: [
-				{
-					messageId: 'optionsNotSorted',
-					data: { displayName: 'unknown', expectedOrder: 'Contact, User' },
-				},
-			],
-		},
-		{
-			name: 'multiple unsorted parameters each report an error',
-			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: [
-							{
-								displayName: 'Resource',
-								name: 'resource',
-								type: 'options',
-								options: [
-									{ name: 'User', value: 'user' },
-									{ name: 'Contact', value: 'contact' },
-								],
-								default: 'user',
-							},
-							{
-								displayName: 'Operation',
-								name: 'operation',
-								type: 'options',
-								options: [
-									{ name: 'Update', value: 'update' },
-									{ name: 'Create', value: 'create' },
-								],
-								default: 'create',
-							},
-						],
-					};
-				}
-			`,
-			errors: [
-				{
-					messageId: 'optionsNotSorted',
-					data: { displayName: 'Resource', expectedOrder: 'Contact, User' },
-				},
-				{
-					messageId: 'optionsNotSorted',
-					data: { displayName: 'Operation', expectedOrder: 'Create, Update' },
-				},
-			],
-		},
-	],
-});

package/src/rules/options-sorted-alphabetically.ts

@@ -1,129 +0,0 @@
-import type { TSESTree } from '@typescript-eslint/utils';
-import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-
-import {
-	isNodeTypeClass,
-	findClassProperty,
-	findObjectProperty,
-	getStringLiteralValue,
-	isFileType,
-	createRule,
-} from '../utils/index.js';
-
-export const OptionsSortedAlphabeticallyRule = createRule({
-	name: 'options-sorted-alphabetically',
-	meta: {
-		type: 'suggestion',
-		docs: {
-			description: 'Enforce alphabetical ordering of options arrays in n8n node properties',
-		},
-		messages: {
-			optionsNotSorted:
-				'Options in "{{ displayName }}" are not sorted alphabetically. Expected order: {{ expectedOrder }}.',
-		},
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.node.ts')) {
-			return {};
-		}
-
-		const analyzeNodeDescription = (descriptionValue: TSESTree.Expression | null): void => {
-			if (!descriptionValue || descriptionValue.type !== AST_NODE_TYPES.ObjectExpression) {
-				return;
-			}
-
-			const propertiesProperty = findObjectProperty(descriptionValue, 'properties');
-			if (
-				!propertiesProperty?.value ||
-				propertiesProperty.value.type !== AST_NODE_TYPES.ArrayExpression
-			) {
-				return;
-			}
-
-			for (const property of propertiesProperty.value.elements) {
-				if (!property || property.type !== AST_NODE_TYPES.ObjectExpression) {
-					continue;
-				}
-
-				const typeProperty = findObjectProperty(property, 'type');
-				const type = typeProperty ? getStringLiteralValue(typeProperty.value) : null;
-
-				if (type !== 'options') {
-					continue;
-				}
-
-				const optionsProperty = findObjectProperty(property, 'options');
-				if (
-					!optionsProperty?.value ||
-					optionsProperty.value.type !== AST_NODE_TYPES.ArrayExpression
-				) {
-					continue;
-				}
-
-				const optionsArray = optionsProperty.value;
-
-				// Extract all option names; skip if any name is non-literal (dynamic options)
-				const names: string[] = [];
-				let hasDynamicName = false;
-
-				for (const option of optionsArray.elements) {
-					if (!option || option.type !== AST_NODE_TYPES.ObjectExpression) {
-						hasDynamicName = true;
-						break;
-					}
-					const nameProperty = findObjectProperty(option, 'name');
-					const name = nameProperty ? getStringLiteralValue(nameProperty.value) : null;
-					if (name === null) {
-						hasDynamicName = true;
-						break;
-					}
-					names.push(name);
-				}
-
-				if (hasDynamicName || names.length <= 1) {
-					continue;
-				}
-
-				const sorted = [...names].sort((a, b) =>
-					a.localeCompare(b, undefined, { sensitivity: 'base' }),
-				);
-
-				const isSorted = names.every((name, i) => name === sorted[i]);
-				if (isSorted) {
-					continue;
-				}
-
-				const displayNameProperty = findObjectProperty(property, 'displayName');
-				const displayName =
-					(displayNameProperty ? getStringLiteralValue(displayNameProperty.value) : null) ??
-					'unknown';
-
-				context.report({
-					node: optionsArray,
-					messageId: 'optionsNotSorted',
-					data: {
-						displayName,
-						expectedOrder: sorted.join(', '),
-					},
-				});
-			}
-		};
-
-		return {
-			ClassDeclaration(node) {
-				if (!isNodeTypeClass(node)) {
-					return;
-				}
-
-				const descriptionProperty = findClassProperty(node, 'description');
-				if (!descriptionProperty) {
-					return;
-				}
-
-				analyzeNodeDescription(descriptionProperty.value);
-			},
-		};
-	},
-});

package/src/rules/require-community-node-keyword.test.ts

@@ -1,82 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { RequireCommunityNodeKeywordRule } from './require-community-node-keyword.js';
-
-const ruleTester = new RuleTester();
-
-ruleTester.run('require-community-node-keyword', RequireCommunityNodeKeywordRule, {
-	valid: [
-		{
-			name: 'keywords array contains required keyword',
-			filename: 'package.json',
-			code: '{ "name": "n8n-nodes-example", "keywords": ["n8n-community-node-package"] }',
-		},
-		{
-			name: 'keywords array contains required keyword among others',
-			filename: 'package.json',
-			code: '{ "name": "n8n-nodes-example", "keywords": ["n8n", "automation", "n8n-community-node-package", "workflow"] }',
-		},
-		{
-			name: 'non-package.json file is ignored',
-			filename: 'some-config.json',
-			code: '{ "name": "n8n-nodes-example" }',
-		},
-		{
-			name: 'nested objects are not checked',
-			filename: 'package.json',
-			code: '{ "name": "n8n-nodes-example", "keywords": ["n8n-community-node-package"], "config": { "nested": "value" } }',
-		},
-		{
-			name: 'objects inside arrays (e.g. contributors) are not flagged',
-			filename: 'package.json',
-			code: `{
-				"name": "n8n-nodes-example",
-				"keywords": ["n8n-community-node-package"],
-				"contributors": [
-					{ "name": "Alice", "email": "alice@example.com" },
-					{ "name": "Bob", "email": "bob@example.com" }
-				]
-			}`,
-		},
-	],
-	invalid: [
-		{
-			name: 'missing keywords array entirely',
-			filename: 'package.json',
-			code: '{ "name": "n8n-nodes-example", "version": "1.0.0" }',
-			output:
-				'{ "name": "n8n-nodes-example", "version": "1.0.0", "keywords": ["n8n-community-node-package"] }',
-			errors: [{ messageId: 'missingKeywordsArray' }],
-		},
-		{
-			name: 'empty keywords array',
-			filename: 'package.json',
-			code: '{ "name": "n8n-nodes-example", "keywords": [] }',
-			output: '{ "name": "n8n-nodes-example", "keywords": ["n8n-community-node-package"] }',
-			errors: [{ messageId: 'missingKeyword' }],
-		},
-		{
-			name: 'keywords array without the required keyword',
-			filename: 'package.json',
-			code: '{ "name": "n8n-nodes-example", "keywords": ["n8n", "automation"] }',
-			output:
-				'{ "name": "n8n-nodes-example", "keywords": ["n8n", "automation", "n8n-community-node-package"] }',
-			errors: [{ messageId: 'missingKeyword' }],
-		},
-		{
-			name: 'keywords array with similar but incorrect keyword',
-			filename: 'package.json',
-			code: '{ "name": "n8n-nodes-example", "keywords": ["n8n-community-node"] }',
-			output:
-				'{ "name": "n8n-nodes-example", "keywords": ["n8n-community-node", "n8n-community-node-package"] }',
-			errors: [{ messageId: 'missingKeyword' }],
-		},
-		{
-			name: 'empty package.json object',
-			filename: 'package.json',
-			code: '{}',
-			output: '{ "keywords": ["n8n-community-node-package"] }',
-			errors: [{ messageId: 'missingKeywordsArray' }],
-		},
-	],
-});