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

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' } }],
-		},
-	],
-});

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

@@ -1,125 +0,0 @@
-import type { TSESTree } from '@typescript-eslint/utils';
-import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-
-import {
-	isNodeTypeClass,
-	findClassProperty,
-	findObjectProperty,
-	getStringLiteralValue,
-	getLiteralValue,
-	isFileType,
-	createRule,
-} from '../utils/index.js';
-
-export const NoDuplicateParamOptionsRule = createRule({
-	name: 'no-duplicate-param-options',
-	meta: {
-		type: 'problem',
-		docs: {
-			description: 'Disallow duplicate option names or values within a single node parameter',
-		},
-		messages: {
-			duplicateName: 'Duplicate option name "{{ value }}" in parameter "{{ displayName }}".',
-			duplicateValue: 'Duplicate option value "{{ value }}" in parameter "{{ displayName }}".',
-		},
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.node.ts')) {
-			return {};
-		}
-
-		const checkProperty = (property: TSESTree.ObjectExpression): void => {
-			const typeProperty = findObjectProperty(property, 'type');
-			const type = typeProperty ? getStringLiteralValue(typeProperty.value) : null;
-			if (type !== 'options' && type !== 'multiOptions') {
-				return;
-			}
-
-			const optionsProperty = findObjectProperty(property, 'options');
-			if (
-				!optionsProperty?.value ||
-				optionsProperty.value.type !== AST_NODE_TYPES.ArrayExpression
-			) {
-				return;
-			}
-
-			const displayNameProperty = findObjectProperty(property, 'displayName');
-			const displayName =
-				(displayNameProperty ? getStringLiteralValue(displayNameProperty.value) : null) ??
-				'unknown';
-
-			const seenNames = new Set<string>();
-			const seenValues = new Set<string | number | boolean>();
-
-			for (const option of optionsProperty.value.elements) {
-				if (!option || option.type !== AST_NODE_TYPES.ObjectExpression) {
-					continue;
-				}
-
-				const nameProperty = findObjectProperty(option, 'name');
-				const name = nameProperty ? getStringLiteralValue(nameProperty.value) : null;
-				if (name !== null) {
-					if (seenNames.has(name)) {
-						context.report({
-							node: nameProperty!.value,
-							messageId: 'duplicateName',
-							data: { value: name, displayName },
-						});
-					}
-					seenNames.add(name);
-				}
-
-				const valueProperty = findObjectProperty(option, 'value');
-				const value = valueProperty ? getLiteralValue(valueProperty.value) : null;
-				if (value !== null) {
-					if (seenValues.has(value)) {
-						context.report({
-							node: valueProperty!.value,
-							messageId: 'duplicateValue',
-							data: { value: String(value), displayName },
-						});
-					}
-					seenValues.add(value);
-				}
-			}
-		};
-
-		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;
-				}
-				checkProperty(property);
-			}
-		};
-
-		return {
-			ClassDeclaration(node) {
-				if (!isNodeTypeClass(node)) {
-					return;
-				}
-
-				const descriptionProperty = findClassProperty(node, 'description');
-				if (!descriptionProperty) {
-					return;
-				}
-
-				analyzeNodeDescription(descriptionProperty.value);
-			},
-		};
-	},
-});

package/src/rules/node-class-description-name-camelcase.test.ts

@@ -1,121 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { NodeClassDescriptionNameCamelCaseRule } from './node-class-description-name-camelcase.js';
-
-const ruleTester = new RuleTester();
-
-function createNodeCode(name: string): string {
-	return `
-import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-export class TestNode implements INodeType {
-	description: INodeTypeDescription = {
-		displayName: 'Test Node',
-		name: '${name}',
-		group: ['input'],
-		version: 1,
-		description: 'A test node',
-		defaults: { name: 'Test Node' },
-		inputs: [],
-		outputs: [],
-		properties: [],
-	};
-}`;
-}
-
-function createNodeCodeWithoutName(): string {
-	return `
-import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-export class TestNode implements INodeType {
-	description: INodeTypeDescription = {
-		displayName: 'Test Node',
-		group: ['input'],
-		version: 1,
-		description: 'A test node',
-		defaults: { name: 'Test Node' },
-		inputs: [],
-		outputs: [],
-		properties: [],
-	};
-}`;
-}
-
-function createRegularClass(): string {
-	return `
-export class SomeHelper {
-	name = 'My Helper';
-}`;
-}
-
-ruleTester.run('node-class-description-name-camelcase', NodeClassDescriptionNameCamelCaseRule, {
-	valid: [
-		{
-			name: 'single lowercase word',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('github'),
-		},
-		{
-			name: 'camelCase multi-word name',
-			filename: '/tmp/GoogleSheets.node.ts',
-			code: createNodeCode('googleSheets'),
-		},
-		{
-			name: 'camelCase name with digits',
-			filename: '/tmp/Oauth2.node.ts',
-			code: createNodeCode('myNode2'),
-		},
-		{
-			name: 'class not implementing INodeType is ignored',
-			filename: '/tmp/Github.node.ts',
-			code: createRegularClass(),
-		},
-		{
-			name: 'non-.node.ts file is ignored',
-			filename: '/tmp/Github.ts',
-			code: createNodeCode('My Node'),
-		},
-		{
-			name: 'missing description.name is ignored',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCodeWithoutName(),
-		},
-	],
-	invalid: [
-		{
-			name: 'PascalCase first letter is lowercased',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('MyNode'),
-			errors: [{ messageId: 'notCamelCase', data: { value: 'MyNode' } }],
-			output: createNodeCode('myNode'),
-		},
-		{
-			name: 'spaces are removed and camelCased',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('My Node'),
-			errors: [{ messageId: 'notCamelCase', data: { value: 'My Node' } }],
-			output: createNodeCode('myNode'),
-		},
-		{
-			name: 'hyphen separators are removed and camelCased',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('my-node'),
-			errors: [{ messageId: 'notCamelCase', data: { value: 'my-node' } }],
-			output: createNodeCode('myNode'),
-		},
-		{
-			name: 'underscore separators are removed and camelCased',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('my_cool_node'),
-			errors: [{ messageId: 'notCamelCase', data: { value: 'my_cool_node' } }],
-			output: createNodeCode('myCoolNode'),
-		},
-		{
-			name: 'names starting with a digit are reported without an autofix',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('123node'),
-			errors: [{ messageId: 'notCamelCase', data: { value: '123node' } }],
-			output: null,
-		},
-	],
-});

package/src/rules/node-class-description-name-camelcase.ts

@@ -1,114 +0,0 @@
-import { TSESTree } from '@typescript-eslint/utils';
-
-import {
-	isNodeTypeClass,
-	findClassProperty,
-	findObjectProperty,
-	getStringLiteralValue,
-	isFileType,
-	createRule,
-} from '../utils/index.js';
-
-// `description.name` must be camelCase: a lowercase letter followed by
-// letters/digits, with no separators.
-const CAMEL_CASE_PATTERN = /^[a-z][a-zA-Z0-9]*$/;
-
-/**
- * Converts an arbitrary node name to camelCase by splitting on any
- * non-alphanumeric separators, upper-casing the first character of each
- * subsequent segment, and lower-casing the very first character.
- * Examples: `My Node` -> `myNode`, `my-node` -> `myNode`, `GitHub` -> `gitHub`.
- */
-function toCamelCase(value: string): string {
-	const segments = value.split(/[^a-zA-Z0-9]+/).filter(Boolean);
-	if (segments.length === 0) {
-		return value;
-	}
-
-	const joined = segments
-		.map((segment, index) =>
-			index === 0 ? segment : segment.charAt(0).toUpperCase() + segment.slice(1),
-		)
-		.join('');
-
-	return joined.charAt(0).toLowerCase() + joined.slice(1);
-}
-
-// Serialize a value as a string literal using the original quote character,
-// escaping any characters that would otherwise break the literal so the
-// autofix never emits invalid code.
-function toStringLiteral(value: string, quote: string): string {
-	const escaped = value
-		.replace(/\\/g, '\\\\')
-		.replace(/\n/g, '\\n')
-		.replace(/\r/g, '\\r')
-		.split(quote)
-		.join(`\\${quote}`);
-	return `${quote}${escaped}${quote}`;
-}
-
-export const NodeClassDescriptionNameCamelCaseRule = createRule({
-	name: 'node-class-description-name-camelcase',
-	meta: {
-		type: 'problem',
-		docs: {
-			description: 'Node class `description.name` must be camelCase',
-		},
-		messages: {
-			notCamelCase: "Node `description.name` '{{value}}' must be camelCase",
-		},
-		fixable: 'code',
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.node.ts')) {
-			return {};
-		}
-
-		return {
-			ClassDeclaration(node) {
-				if (!isNodeTypeClass(node)) {
-					return;
-				}
-
-				const descriptionProperty = findClassProperty(node, 'description');
-				if (descriptionProperty?.value?.type !== TSESTree.AST_NODE_TYPES.ObjectExpression) {
-					return;
-				}
-
-				const nameProperty = findObjectProperty(descriptionProperty.value, 'name');
-				if (!nameProperty) {
-					return;
-				}
-
-				const nameValue = getStringLiteralValue(nameProperty.value);
-				if (nameValue === null) {
-					return;
-				}
-
-				if (CAMEL_CASE_PATTERN.test(nameValue)) {
-					return;
-				}
-
-				const valueNode = nameProperty.value;
-				const fixedValue = toCamelCase(nameValue);
-				// Only offer an autofix when it actually yields a valid camelCase
-				// value (e.g. names starting with a digit cannot be repaired).
-				const canFix = fixedValue !== nameValue && CAMEL_CASE_PATTERN.test(fixedValue);
-
-				context.report({
-					node: valueNode,
-					messageId: 'notCamelCase',
-					data: { value: nameValue },
-					fix: canFix
-						? (fixer) => {
-								const quote = context.sourceCode.getText(valueNode).charAt(0);
-								return fixer.replaceText(valueNode, toStringLiteral(fixedValue, quote));
-							}
-						: undefined,
-				});
-			},
-		};
-	},
-});

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

@@ -1,115 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { NodeFilenameAgainstConventionRule } from './node-filename-against-convention.js';
-
-const ruleTester = new RuleTester();
-
-function createNodeCode(name: string): string {
-	return `
-import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-export class TestNode implements INodeType {
-	description: INodeTypeDescription = {
-		displayName: 'Test Node',
-		name: '${name}',
-		group: ['input'],
-		version: 1,
-		description: 'A test node',
-		defaults: { name: 'Test Node' },
-		inputs: [],
-		outputs: [],
-		properties: [],
-	};
-}`;
-}
-
-function createNodeCodeWithoutName(): string {
-	return `
-import type { INodeType, INodeTypeDescription } from 'n8n-workflow';
-
-export class TestNode implements INodeType {
-	description: INodeTypeDescription = {
-		displayName: 'Test Node',
-		group: ['input'],
-		version: 1,
-		description: 'A test node',
-		defaults: { name: 'Test Node' },
-		inputs: [],
-		outputs: [],
-		properties: [],
-	};
-}`;
-}
-
-function createRegularClass(): string {
-	return `
-export class SomeHelper {
-	name = 'github';
-}`;
-}
-
-ruleTester.run('node-filename-against-convention', NodeFilenameAgainstConventionRule, {
-	valid: [
-		{
-			name: 'filename matches PascalCased description.name',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('github'),
-		},
-		{
-			name: 'filename with version suffix is accepted',
-			filename: '/tmp/GithubV2.node.ts',
-			code: createNodeCode('github'),
-		},
-		{
-			name: 'filename with multi-digit version suffix is accepted',
-			filename: '/tmp/GithubV10.node.ts',
-			code: createNodeCode('github'),
-		},
-		{
-			name: 'multi-word camelCase name maps to PascalCase filename',
-			filename: '/tmp/GoogleSheets.node.ts',
-			code: createNodeCode('googleSheets'),
-		},
-		{
-			name: 'class not implementing INodeType is ignored',
-			filename: '/tmp/Github.node.ts',
-			code: createRegularClass(),
-		},
-		{
-			name: 'non-.node.ts file is ignored',
-			filename: '/tmp/Github.ts',
-			code: createNodeCode('mismatch'),
-		},
-		{
-			name: 'missing description.name is ignored',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCodeWithoutName(),
-		},
-	],
-	invalid: [
-		{
-			name: 'filename does not match description.name',
-			filename: '/tmp/Github.node.ts',
-			code: createNodeCode('gitlab'),
-			errors: [{ messageId: 'renameFile', data: { expected: 'Gitlab.node.ts' } }],
-		},
-		{
-			name: 'filename is lowercased',
-			filename: '/tmp/github.node.ts',
-			code: createNodeCode('github'),
-			errors: [{ messageId: 'renameFile', data: { expected: 'Github.node.ts' } }],
-		},
-		{
-			name: 'filename has wrong internal casing',
-			filename: '/tmp/GitHub.node.ts',
-			code: createNodeCode('github'),
-			errors: [{ messageId: 'renameFile', data: { expected: 'Github.node.ts' } }],
-		},
-		{
-			name: 'version suffix does not excuse a mismatched base name',
-			filename: '/tmp/GitlabV2.node.ts',
-			code: createNodeCode('github'),
-			errors: [{ messageId: 'renameFile', data: { expected: 'Github.node.ts' } }],
-		},
-	],
-});