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

package/src/rules/cred-class-name-field-conventions.test.ts

@@ -1,121 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { CredClassNameFieldConventionsRule } from './cred-class-name-field-conventions.js';
-
-const ruleTester = new RuleTester();
-
-const credFilePath = '/tmp/TestCredential.credentials.ts';
-const nonCredFilePath = '/tmp/SomeHelper.ts';
-
-function createCredentialCode(name: string): string {
-	return `
-import type { ICredentialType, INodeProperties } from 'n8n-workflow';
-
-export class TestApi implements ICredentialType {
-	name = '${name}';
-	displayName = 'Test API';
-	properties: INodeProperties[] = [];
-}`;
-}
-
-function createRegularClass(name: string): string {
-	return `
-export class SomeHelper {
-	name = '${name}';
-}`;
-}
-
-// Embeds the raw literal text (including its quotes) verbatim, so tests can
-// exercise names containing quote characters that need escaping.
-function createCredentialCodeWithLiteral(literal: string): string {
-	return `
-import type { ICredentialType, INodeProperties } from 'n8n-workflow';
-
-export class TestApi implements ICredentialType {
-	name = ${literal};
-	displayName = 'Test API';
-	properties: INodeProperties[] = [];
-}`;
-}
-
-ruleTester.run('cred-class-name-field-conventions', CredClassNameFieldConventionsRule, {
-	valid: [
-		{
-			name: 'name field with Api suffix and lowercase first char',
-			filename: credFilePath,
-			code: createCredentialCode('githubApi'),
-		},
-		{
-			name: 'OAuth2 name field is also valid',
-			filename: credFilePath,
-			code: createCredentialCode('githubOAuth2Api'),
-		},
-		{
-			name: 'class not implementing ICredentialType is ignored',
-			filename: credFilePath,
-			code: createRegularClass('Github'),
-		},
-		{
-			name: 'non-.credentials.ts file is ignored',
-			filename: nonCredFilePath,
-			code: createCredentialCode('Github'),
-		},
-	],
-	invalid: [
-		{
-			name: 'name field missing Api suffix',
-			filename: credFilePath,
-			code: createCredentialCode('github'),
-			errors: [{ messageId: 'missingSuffix', data: { value: 'github' } }],
-			output: createCredentialCode('githubApi'),
-		},
-		{
-			name: 'name field with uppercase first char',
-			filename: credFilePath,
-			code: createCredentialCode('GithubApi'),
-			errors: [{ messageId: 'uppercaseFirstChar', data: { value: 'GithubApi' } }],
-			output: createCredentialCode('githubApi'),
-		},
-		{
-			name: 'name field with both uppercase first char and missing suffix',
-			filename: credFilePath,
-			code: createCredentialCode('Github'),
-			errors: [
-				{ messageId: 'uppercaseFirstChar', data: { value: 'Github' } },
-				{ messageId: 'missingSuffix', data: { value: 'Github' } },
-			],
-			output: createCredentialCode('githubApi'),
-		},
-		{
-			name: 'name field ending in Ap',
-			filename: credFilePath,
-			code: createCredentialCode('githubAp'),
-			errors: [{ messageId: 'missingSuffix', data: { value: 'githubAp' } }],
-			output: createCredentialCode('githubApi'),
-		},
-		{
-			name: 'name field ending in A',
-			filename: credFilePath,
-			code: createCredentialCode('githubA'),
-			errors: [{ messageId: 'missingSuffix', data: { value: 'githubA' } }],
-			output: createCredentialCode('githubApi'),
-		},
-		{
-			name: 'autofix escapes single quotes in the name value',
-			filename: credFilePath,
-			code: createCredentialCodeWithLiteral("'git\\'hub'"),
-			errors: [{ messageId: 'missingSuffix', data: { value: "git'hub" } }],
-			output: createCredentialCodeWithLiteral("'git\\'hubApi'"),
-		},
-		{
-			name: 'autofix preserves double quotes and escapes them in the name value',
-			filename: credFilePath,
-			code: createCredentialCodeWithLiteral('"Git\\"hub"'),
-			errors: [
-				{ messageId: 'uppercaseFirstChar', data: { value: 'Git"hub' } },
-				{ messageId: 'missingSuffix', data: { value: 'Git"hub' } },
-			],
-			output: createCredentialCodeWithLiteral('"git\\"hubApi"'),
-		},
-	],
-});

package/src/rules/cred-class-name-field-conventions.ts

@@ -1,102 +0,0 @@
-import {
-	createRule,
-	findClassProperty,
-	getStringLiteralValue,
-	isCredentialTypeClass,
-	isFileType,
-} from '../utils/index.js';
-
-function lowercaseFirstChar(name: string): string {
-	return name.charAt(0).toLowerCase() + name.slice(1);
-}
-
-function addApiSuffix(name: string): string {
-	if (name.endsWith('Api')) return name;
-	if (name.endsWith('Ap')) return `${name}i`;
-	if (name.endsWith('A')) return `${name}pi`;
-	return `${name}Api`;
-}
-
-// 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 (e.g. names containing quotes).
-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 CredClassNameFieldConventionsRule = createRule({
-	name: 'cred-class-name-field-conventions',
-	meta: {
-		type: 'problem',
-		docs: {
-			description: 'Credential `name` field must end with `Api` and start with a lowercase letter',
-		},
-		messages: {
-			missingSuffix: "Credential `name` field '{{value}}' must end with 'Api'",
-			uppercaseFirstChar: "Credential `name` field '{{value}}' must start with a lowercase letter",
-		},
-		fixable: 'code',
-		schema: [],
-	},
-	defaultOptions: [],
-	create(context) {
-		if (!isFileType(context.filename, '.credentials.ts')) {
-			return {};
-		}
-
-		return {
-			ClassDeclaration(node) {
-				if (!isCredentialTypeClass(node)) {
-					return;
-				}
-
-				const nameProperty = findClassProperty(node, 'name');
-				if (!nameProperty?.value) {
-					return;
-				}
-
-				const nameValue = getStringLiteralValue(nameProperty.value);
-				if (nameValue === null) {
-					return;
-				}
-
-				const startsLowercase = !/^[A-Z]/.test(nameValue);
-				const endsWithApi = nameValue.endsWith('Api');
-				if (startsLowercase && endsWithApi) {
-					return;
-				}
-
-				// Compute the fully-corrected value once so each fix yields the
-				// same result in a single pass, regardless of which one applies.
-				const fixedValue = addApiSuffix(lowercaseFirstChar(nameValue));
-				const valueNode = nameProperty.value;
-				const quote = context.sourceCode.getText(valueNode).charAt(0);
-				const replacement = toStringLiteral(fixedValue, quote);
-
-				if (!startsLowercase) {
-					context.report({
-						node: valueNode,
-						messageId: 'uppercaseFirstChar',
-						data: { value: nameValue },
-						fix: (fixer) => fixer.replaceText(valueNode, replacement),
-					});
-				}
-
-				if (!endsWithApi) {
-					context.report({
-						node: valueNode,
-						messageId: 'missingSuffix',
-						data: { value: nameValue },
-						fix: (fixer) => fixer.replaceText(valueNode, replacement),
-					});
-				}
-			},
-		};
-	},
-});

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

@@ -1,74 +0,0 @@
-import { RuleTester } from '@typescript-eslint/rule-tester';
-
-import { CredClassNameSuffixRule } from './cred-class-name-suffix.js';
-
-const ruleTester = new RuleTester();
-
-const credFilePath = '/tmp/TestCredential.credentials.ts';
-const nonCredFilePath = '/tmp/SomeHelper.ts';
-
-function createCredentialCode(className: string): string {
-	return `
-import type { ICredentialType, INodeProperties } from 'n8n-workflow';
-
-export class ${className} implements ICredentialType {
-	name = 'testApi';
-	displayName = 'Test API';
-	properties: INodeProperties[] = [];
-}`;
-}
-
-function createRegularClass(className: string): string {
-	return `
-export class ${className} {
-	name = 'test';
-}`;
-}
-
-ruleTester.run('cred-class-name-suffix', CredClassNameSuffixRule, {
-	valid: [
-		{
-			name: 'credential class with Api suffix',
-			filename: credFilePath,
-			code: createCredentialCode('TestApi'),
-		},
-		{
-			name: 'credential class with OAuth2Api suffix',
-			filename: credFilePath,
-			code: createCredentialCode('TestOAuth2Api'),
-		},
-		{
-			name: 'class not implementing ICredentialType is ignored',
-			filename: credFilePath,
-			code: createRegularClass('SomeHelper'),
-		},
-		{
-			name: 'non-.credentials.ts file is ignored',
-			filename: nonCredFilePath,
-			code: createCredentialCode('TestCredential'),
-		},
-	],
-	invalid: [
-		{
-			name: 'credential class missing Api suffix',
-			filename: credFilePath,
-			code: createCredentialCode('TestCredential'),
-			errors: [{ messageId: 'missingSuffix', data: { name: 'TestCredential' } }],
-			output: createCredentialCode('TestCredentialApi'),
-		},
-		{
-			name: 'credential class name ending in Ap',
-			filename: credFilePath,
-			code: createCredentialCode('TestAp'),
-			errors: [{ messageId: 'missingSuffix', data: { name: 'TestAp' } }],
-			output: createCredentialCode('TestApi'),
-		},
-		{
-			name: 'credential class name ending in A',
-			filename: credFilePath,
-			code: createCredentialCode('TestA'),
-			errors: [{ messageId: 'missingSuffix', data: { name: 'TestA' } }],
-			output: createCredentialCode('TestApi'),
-		},
-	],
-});

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