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

package/src/rules/trigger-node-conventions.ts

@@ -0,0 +1,92 @@
+import { TSESTree } from '@typescript-eslint/utils';
+
+import {
+	isNodeTypeClass,
+	findClassProperty,
+	findObjectProperty,
+	getStringLiteralValue,
+	isFileType,
+	createRule,
+} from '../utils/index.js';
+
+export const TriggerNodeConventionsRule = createRule({
+	name: 'trigger-node-conventions',
+	meta: {
+		type: 'problem',
+		docs: {
+			description:
+				'Trigger nodes (class name ends with `Trigger`) must label themselves consistently as triggers',
+		},
+		messages: {
+			nameMissingSuffix: "Trigger node `description.name` '{{value}}' must end with 'Trigger'",
+			displayNameMissingTrigger:
+				"Trigger node `description.displayName` '{{value}}' must contain 'Trigger'",
+			inputsNotEmpty: 'Trigger node `description.inputs` must be an empty array `[]`',
+		},
+		schema: [],
+	},
+	defaultOptions: [],
+	create(context) {
+		if (!isFileType(context.filename, '.node.ts')) {
+			return {};
+		}
+
+		return {
+			ClassDeclaration(node) {
+				if (!isNodeTypeClass(node)) {
+					return;
+				}
+
+				if (!node.id?.name.endsWith('Trigger')) {
+					return;
+				}
+
+				const descriptionProperty = findClassProperty(node, 'description');
+				if (descriptionProperty?.value?.type !== TSESTree.AST_NODE_TYPES.ObjectExpression) {
+					return;
+				}
+				const description = descriptionProperty.value;
+
+				const displayNameProperty = findObjectProperty(description, 'displayName');
+				const displayNameValue = displayNameProperty
+					? getStringLiteralValue(displayNameProperty.value)
+					: null;
+				if (
+					displayNameProperty &&
+					displayNameValue !== null &&
+					!displayNameValue.includes('Trigger')
+				) {
+					context.report({
+						node: displayNameProperty.value,
+						messageId: 'displayNameMissingTrigger',
+						data: { value: displayNameValue },
+					});
+				}
+
+				const nameProperty = findObjectProperty(description, 'name');
+				const nameValue = nameProperty ? getStringLiteralValue(nameProperty.value) : null;
+				if (nameProperty && nameValue !== null && !nameValue.endsWith('Trigger')) {
+					context.report({
+						node: nameProperty.value,
+						messageId: 'nameMissingSuffix',
+						data: { value: nameValue },
+					});
+				}
+
+				const inputsProperty = findObjectProperty(description, 'inputs');
+				if (
+					inputsProperty &&
+					!(
+						inputsProperty.value.type === TSESTree.AST_NODE_TYPES.ArrayExpression &&
+						inputsProperty.value.elements.length === 0
+					)
+				) {
+					context.report({
+						node: inputsProperty.value,
+						messageId: 'inputsNotEmpty',
+					});
+				}
+			},
+		};
+	},
+});

package/src/rules/valid-peer-dependencies.test.ts

@@ -11,6 +11,11 @@ ruleTester.run('valid-peer-dependencies', ValidPeerDependenciesRule, {
 			filename: 'package.json',
 			code: '{ "name": "n8n-nodes-example", "peerDependencies": { "n8n-workflow": "*" } }',
 		},
+		{
+			name: 'n8n-workflow and scoped @n8n/ai-node-sdk',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "peerDependencies": { "n8n-workflow": "*", "@n8n/ai-node-sdk": "*" } }',
+		},
 		{
 			name: 'n8n-workflow and ai-node-sdk',
 			filename: 'package.json',

package/src/rules/valid-peer-dependencies.ts

@@ -5,7 +5,9 @@ import { createRule, findJsonProperty } from '../utils/index.js';
 
 const REQUIRED_DEP = 'n8n-workflow';
 const REQUIRED_VERSION = '*';
-const ALLOWED_DEPS = new Set([REQUIRED_DEP, 'ai-node-sdk']);
+// The published SDK is scoped (@n8n/ai-node-sdk); the unscoped name is kept for
+// backwards compatibility, mirroring no-restricted-imports.
+const ALLOWED_DEPS = new Set([REQUIRED_DEP, '@n8n/ai-node-sdk', 'ai-node-sdk']);
 
 export const ValidPeerDependenciesRule = createRule({
 	name: 'valid-peer-dependencies',
@@ -13,7 +15,7 @@ export const ValidPeerDependenciesRule = createRule({
 		type: 'problem',
 		docs: {
 			description:
-				'Require community node package.json peerDependencies to contain only "n8n-workflow": "*" (and optionally "ai-node-sdk")',
+				'Require community node package.json peerDependencies to contain only "n8n-workflow": "*" (and optionally "@n8n/ai-node-sdk")',
 		},
 		fixable: 'code',
 		messages: {
@@ -22,7 +24,7 @@ export const ValidPeerDependenciesRule = createRule({
 			missingN8nWorkflow: `"peerDependencies" must include "${REQUIRED_DEP}": "${REQUIRED_VERSION}".`,
 			pinnedN8nWorkflow: `"peerDependencies.${REQUIRED_DEP}" must be "${REQUIRED_VERSION}", got {{ value }}.`,
 			forbiddenPeerDependency:
-				'"{{ name }}" is not allowed in "peerDependencies". Only "n8n-workflow" and "ai-node-sdk" are permitted.',
+				'"{{ name }}" is not allowed in "peerDependencies". Only "n8n-workflow" and "@n8n/ai-node-sdk" are permitted.',
 		},
 		schema: [],
 	},