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

package/src/rules/cred-class-name-suffix.ts

@@ -1,57 +0,0 @@
-import { isCredentialTypeClass, isFileType, createRule } from '../utils/index.js';
-
-function addApiSuffix(name: string): string {
-	if (name.endsWith('Ap')) return `${name}i`;
-	if (name.endsWith('A')) return `${name}pi`;
-	return `${name}Api`;
-}
-
-export const CredClassNameSuffixRule = createRule({
-	name: 'cred-class-name-suffix',
-	meta: {
-		type: 'problem',
-		docs: {
-			description: 'Credential class names must be suffixed with `Api`',
-		},
-		messages: {
-			missingSuffix: "Credential class name '{{name}}' must end with 'Api'",
-		},
-		fixable: 'code',
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.credentials.ts')) {
-			return {};
-		}
-
-		return {
-			ClassDeclaration(node) {
-				if (!isCredentialTypeClass(node)) {
-					return;
-				}
-
-				const classNameNode = node.id;
-				if (!classNameNode) {
-					return;
-				}
-
-				const className = classNameNode.name;
-				if (className.endsWith('Api')) {
-					return;
-				}
-
-				const fixedName = addApiSuffix(className);
-
-				context.report({
-					node: classNameNode,
-					messageId: 'missingSuffix',
-					data: { name: className },
-					fix(fixer) {
-						return fixer.replaceText(classNameNode, fixedName);
-					},
-				});
-			},
-		};
-	},
-});

package/src/rules/cred-filename-against-convention.test.ts

@@ -1,72 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { CredFilenameAgainstConventionRule } from './cred-filename-against-convention.js';
-
-const ruleTester = new RuleTester();
-
-function createCredentialCode(className: string): string {
-	return `
-import type { ICredentialType, INodeProperties } from 'n8n-workflow';
-
-export class ${className} implements ICredentialType {
-	name = '${className.charAt(0).toLowerCase() + className.slice(1)}';
-	displayName = '${className}';
-	properties: INodeProperties[] = [];
-}`;
-}
-
-function createRegularClass(): string {
-	return `
-export class SomeHelper {
-	name = 'githubApi';
-}`;
-}
-
-ruleTester.run('cred-filename-against-convention', CredFilenameAgainstConventionRule, {
-	valid: [
-		{
-			name: 'filename matches credential class name',
-			filename: '/tmp/GithubApi.credentials.ts',
-			code: createCredentialCode('GithubApi'),
-		},
-		{
-			name: 'multi-word class name matches filename',
-			filename: '/tmp/GoogleSheetsOAuth2Api.credentials.ts',
-			code: createCredentialCode('GoogleSheetsOAuth2Api'),
-		},
-		{
-			name: 'class not implementing ICredentialType is ignored',
-			filename: '/tmp/Github.credentials.ts',
-			code: createRegularClass(),
-		},
-		{
-			name: 'non-.credentials.ts file is ignored',
-			filename: '/tmp/GithubApi.ts',
-			code: createCredentialCode('Mismatch'),
-		},
-	],
-	invalid: [
-		{
-			name: 'filename does not match class name',
-			filename: '/tmp/GithubApi.credentials.ts',
-			code: createCredentialCode('GitlabApi'),
-			errors: [
-				{
-					messageId: 'renameFile',
-					data: { className: 'GitlabApi', expected: 'GitlabApi.credentials.ts' },
-				},
-			],
-		},
-		{
-			name: 'filename has wrong casing',
-			filename: '/tmp/githubApi.credentials.ts',
-			code: createCredentialCode('GithubApi'),
-			errors: [
-				{
-					messageId: 'renameFile',
-					data: { className: 'GithubApi', expected: 'GithubApi.credentials.ts' },
-				},
-			],
-		},
-	],
-});

package/src/rules/cred-filename-against-convention.ts

@@ -1,48 +0,0 @@
-import * as path from 'node:path';
-
-import { isCredentialTypeClass, isFileType, createRule } from '../utils/index.js';
-
-export const CredFilenameAgainstConventionRule = createRule({
-	name: 'cred-filename-against-convention',
-	meta: {
-		type: 'problem',
-		docs: {
-			description: 'Credential filename must match the credential class name',
-		},
-		messages: {
-			renameFile:
-				'Credential filename must match the class name "{{className}}". Rename file to "{{expected}}".',
-		},
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.credentials.ts')) {
-			return {};
-		}
-
-		return {
-			ClassDeclaration(node) {
-				if (!isCredentialTypeClass(node)) {
-					return;
-				}
-
-				const classNameNode = node.id;
-				if (!classNameNode) {
-					return;
-				}
-
-				const className = classNameNode.name;
-				const actualBaseName = path.basename(context.filename, '.credentials.ts');
-
-				if (actualBaseName !== className) {
-					context.report({
-						node: classNameNode,
-						messageId: 'renameFile',
-						data: { className, expected: `${className}.credentials.ts` },
-					});
-				}
-			},
-		};
-	},
-});

package/src/rules/no-asterisk-in-option-names.test.ts

@@ -1,185 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { NoAsteriskInOptionNamesRule } from './no-asterisk-in-option-names.js';
-
-const ruleTester = new RuleTester();
-
-function createNodeCode(body: string): string {
-	return `
-		import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-		export class TestNode implements INodeType {
-			description: INodeTypeDescription = {
-				${body}
-			};
-		}
-	`;
-}
-
-ruleTester.run('no-asterisk-in-option-names', NoAsteriskInOptionNamesRule, {
-	valid: [
-		{
-			name: 'class that does not implement INodeType',
-			filename: '/tmp/TestNode.node.ts',
-			code: `
-				export class NotANode {
-					description = {
-						properties: [
-							{ options: [{ name: '* All', value: 'all' }] },
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'non .node.ts file is ignored',
-			filename: '/tmp/helper.ts',
-			code: `
-				export class TestNode {
-					description = {
-						properties: [
-							{ options: [{ name: '* All', value: 'all' }] },
-						],
-					};
-				}
-			`,
-		},
-		{
-			name: 'option names without asterisk',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				displayName: 'Test Node',
-				name: 'testNode',
-				properties: [
-					{
-						displayName: 'Operation',
-						name: 'operation',
-						type: 'options',
-						options: [
-							{ name: 'Create', value: 'create' },
-							{ name: '[All]', value: 'all' },
-						],
-						default: 'create',
-					},
-				],
-			`),
-		},
-		{
-			name: 'asterisk in displayName outside options is ignored',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				displayName: 'Test * Node',
-				name: 'testNode',
-				properties: [
-					{ displayName: 'Field *', name: 'field', type: 'string', default: '' },
-				],
-			`),
-		},
-	],
-	invalid: [
-		{
-			name: 'asterisk in option name within options array',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				displayName: 'Test Node',
-				name: 'testNode',
-				properties: [
-					{
-						displayName: 'Resource',
-						name: 'resource',
-						type: 'options',
-						options: [
-							{ name: '* All', value: 'all' },
-							{ name: 'User', value: 'user' },
-						],
-						default: 'all',
-					},
-				],
-			`),
-			errors: [
-				{
-					messageId: 'asteriskInOptionName',
-					data: { name: '* All' },
-					suggestions: [
-						{
-							messageId: 'replaceAsterisk',
-							output: createNodeCode(`
-				displayName: 'Test Node',
-				name: 'testNode',
-				properties: [
-					{
-						displayName: 'Resource',
-						name: 'resource',
-						type: 'options',
-						options: [
-							{ name: '[All] All', value: 'all' },
-							{ name: 'User', value: 'user' },
-						],
-						default: 'all',
-					},
-				],
-			`),
-						},
-					],
-				},
-			],
-		},
-		{
-			name: 'asterisk in nested collection options',
-			filename: '/tmp/TestNode.node.ts',
-			code: createNodeCode(`
-				displayName: 'Test Node',
-				name: 'testNode',
-				properties: [
-					{
-						displayName: 'Filters',
-						name: 'filters',
-						type: 'collection',
-						default: {},
-						options: [
-							{
-								displayName: 'Status',
-								name: 'status',
-								type: 'options',
-								options: [{ name: '*', value: 'any' }],
-								default: 'any',
-							},
-						],
-					},
-				],
-			`),
-			errors: [
-				{
-					messageId: 'asteriskInOptionName',
-					data: { name: '*' },
-					suggestions: [
-						{
-							messageId: 'replaceAsterisk',
-							output: createNodeCode(`
-				displayName: 'Test Node',
-				name: 'testNode',
-				properties: [
-					{
-						displayName: 'Filters',
-						name: 'filters',
-						type: 'collection',
-						default: {},
-						options: [
-							{
-								displayName: 'Status',
-								name: 'status',
-								type: 'options',
-								options: [{ name: '[All]', value: 'any' }],
-								default: 'any',
-							},
-						],
-					},
-				],
-			`),
-						},
-					],
-				},
-			],
-		},
-	],
-});

package/src/rules/no-asterisk-in-option-names.ts

@@ -1,111 +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 NoAsteriskInOptionNamesRule = createRule({
-	name: 'no-asterisk-in-option-names',
-	meta: {
-		type: 'suggestion',
-		docs: {
-			description: 'Disallow asterisk characters in node option name values',
-		},
-		hasSuggestions: true,
-		messages: {
-			asteriskInOptionName:
-				'Option name "{{ name }}" contains "*", which renders ambiguously in the n8n UI. Use bracketed notation like "[All]" instead.',
-			replaceAsterisk: 'Replace "*" with "[All]".',
-		},
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.node.ts')) {
-			return {};
-		}
-
-		// Check every object that is a direct element of an `options` array.
-		const checkOptionsArray = (optionsArray: TSESTree.ArrayExpression): void => {
-			for (const option of optionsArray.elements) {
-				if (!option || option.type !== AST_NODE_TYPES.ObjectExpression) {
-					continue;
-				}
-
-				const valueNode = findObjectProperty(option, 'name')?.value;
-				if (!valueNode) {
-					continue;
-				}
-
-				const name = getStringLiteralValue(valueNode);
-				if (!name?.includes('*')) {
-					continue;
-				}
-
-				context.report({
-					node: valueNode,
-					messageId: 'asteriskInOptionName',
-					data: { name },
-					suggest: [
-						{
-							messageId: 'replaceAsterisk',
-							fix(fixer) {
-								const quote = context.sourceCode.getText(valueNode).at(0) ?? "'";
-								return fixer.replaceText(
-									valueNode,
-									`${quote}${name.replaceAll('*', '[All]')}${quote}`,
-								);
-							},
-						},
-					],
-				});
-			}
-		};
-
-		const traverse = (node: TSESTree.Node): void => {
-			if (node.type === AST_NODE_TYPES.ObjectExpression) {
-				const optionsProperty = findObjectProperty(node, 'options');
-				if (optionsProperty?.value.type === AST_NODE_TYPES.ArrayExpression) {
-					checkOptionsArray(optionsProperty.value);
-				}
-			}
-
-			for (const key in node) {
-				if (key === 'parent') {
-					continue;
-				}
-				const child = node[key as keyof TSESTree.Node] as unknown;
-				if (Array.isArray(child)) {
-					for (const item of child) {
-						if (item && typeof item === 'object' && 'type' in item) {
-							traverse(item as TSESTree.Node);
-						}
-					}
-				} else if (child && typeof child === 'object' && 'type' in child) {
-					traverse(child as TSESTree.Node);
-				}
-			}
-		};
-
-		return {
-			ClassDeclaration(node) {
-				if (!isNodeTypeClass(node)) {
-					return;
-				}
-
-				const descriptionProperty = findClassProperty(node, 'description');
-				if (!descriptionProperty?.value) {
-					return;
-				}
-
-				traverse(descriptionProperty.value);
-			},
-		};
-	},
-});

package/src/rules/no-duplicate-param-options.test.ts

@@ -1,125 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { NoDuplicateParamOptionsRule } from './no-duplicate-param-options.js';
-
-const ruleTester = new RuleTester();
-
-function nodeCode(options: string, type = 'options'): string {
-	return `
-		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: '${type}',
-						options: [${options}],
-						default: '',
-					},
-				],
-			};
-		}
-	`;
-}
-
-ruleTester.run('no-duplicate-param-options', NoDuplicateParamOptionsRule, {
-	valid: [
-		{
-			name: 'non-INodeType class is skipped',
-			filename: '/tmp/TestNode.node.ts',
-			code: 'export class Foo {}',
-		},
-		{
-			name: 'unique names and values',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(`
-				{ name: 'Create', value: 'create' },
-				{ name: 'Delete', value: 'delete' },
-			`),
-		},
-		{
-			name: 'unique numeric values',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(`
-				{ name: 'One', value: 1 },
-				{ name: 'Two', value: 2 },
-			`),
-		},
-		{
-			name: 'multiOptions with unique options',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(
-				`
-				{ name: 'A', value: 'a' },
-				{ name: 'B', value: 'b' },
-			`,
-				'multiOptions',
-			),
-		},
-		{
-			name: 'non-node.ts file is skipped',
-			filename: '/tmp/TestNode.ts',
-			code: nodeCode(`
-				{ name: 'Dup', value: 'a' },
-				{ name: 'Dup', value: 'b' },
-			`),
-		},
-	],
-	invalid: [
-		{
-			name: 'duplicate name',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(`
-				{ name: 'Create', value: 'create' },
-				{ name: 'Create', value: 'create2' },
-			`),
-			errors: [{ messageId: 'duplicateName', data: { value: 'Create', displayName: 'Resource' } }],
-		},
-		{
-			name: 'duplicate value',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(`
-				{ name: 'Create', value: 'create' },
-				{ name: 'Make', value: 'create' },
-			`),
-			errors: [{ messageId: 'duplicateValue', data: { value: 'create', displayName: 'Resource' } }],
-		},
-		{
-			name: 'duplicate numeric value',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(`
-				{ name: 'One', value: 1 },
-				{ name: 'Uno', value: 1 },
-			`),
-			errors: [{ messageId: 'duplicateValue', data: { value: '1', displayName: 'Resource' } }],
-		},
-		{
-			name: 'duplicate name and value reported separately',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(`
-				{ name: 'Create', value: 'create' },
-				{ name: 'Create', value: 'create' },
-			`),
-			errors: [
-				{ messageId: 'duplicateName', data: { value: 'Create', displayName: 'Resource' } },
-				{ messageId: 'duplicateValue', data: { value: 'create', displayName: 'Resource' } },
-			],
-		},
-		{
-			name: 'duplicate in multiOptions',
-			filename: '/tmp/TestNode.node.ts',
-			code: nodeCode(
-				`
-				{ name: 'A', value: 'a' },
-				{ name: 'A', value: 'b' },
-			`,
-				'multiOptions',
-			),
-			errors: [{ messageId: 'duplicateName', data: { value: 'A', displayName: 'Resource' } }],
-		},
-	],
-});