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

package/docs/rules/no-asterisk-in-option-names.md

@@ -0,0 +1,61 @@
+# Disallow asterisk characters in node option name values (`@n8n/community-nodes/no-asterisk-in-option-names`)
+
+⚠️ This rule _warns_ in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+The `name` of each entry in an `options` array is rendered directly in the n8n
+editor. An asterisk (`*`) in these labels renders ambiguously — it reads like a
+markdown bullet or emphasis marker rather than literal text. This rule flags any
+option `name` containing `*` and suggests replacing it with bracketed notation
+such as `[All]`.
+
+The rule only inspects `name` values inside `options` arrays (including nested
+`collection` and `fixedCollection` options); asterisks elsewhere are not
+reported.
+
+## Examples
+
+### Incorrect
+
+```typescript
+export class MyNode implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Node',
+    name: 'myNode',
+    properties: [
+      {
+        displayName: 'Resource',
+        name: 'resource',
+        type: 'options',
+        options: [{ name: '* All', value: 'all' }],
+        default: 'all',
+      },
+    ],
+  };
+}
+```
+
+### Correct
+
+```typescript
+export class MyNode implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Node',
+    name: 'myNode',
+    properties: [
+      {
+        displayName: 'Resource',
+        name: 'resource',
+        type: 'options',
+        options: [{ name: '[All]', value: 'all' }],
+        default: 'all',
+      },
+    ],
+  };
+}
+```

package/docs/rules/no-duplicate-param-options.md

@@ -0,0 +1,46 @@
+# Disallow duplicate option names or values within a single node parameter (`@n8n/community-nodes/no-duplicate-param-options`)
+
+⚠️ This rule _warns_ in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+Within an `options`- or `multiOptions`-typed node parameter, each option must
+have a unique `name` and a unique `value`. Duplicate names confuse users in the
+dropdown, and duplicate values make selections ambiguous and break value-based
+logic downstream.
+
+## Examples
+
+### Incorrect
+
+```typescript
+{
+  displayName: 'Resource',
+  name: 'resource',
+  type: 'options',
+  options: [
+    { name: 'Contact', value: 'contact' },
+    { name: 'Contact', value: 'person' }, // duplicate name
+    { name: 'User', value: 'contact' },   // duplicate value
+  ],
+  default: 'contact',
+}
+```
+
+### Correct
+
+```typescript
+{
+  displayName: 'Resource',
+  name: 'resource',
+  type: 'options',
+  options: [
+    { name: 'Contact', value: 'contact' },
+    { name: 'Person', value: 'person' },
+    { name: 'User', value: 'user' },
+  ],
+  default: 'contact',
+}
+```

package/docs/rules/require-mit-license.md

@@ -0,0 +1,38 @@
+# Require the "license" field in community node package.json to be "MIT" (`@n8n/community-nodes/require-mit-license`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+Validates that the `package.json` of a community node package declares its `license` as `"MIT"`. Community node packages must be MIT licensed to be distributed through n8n.
+
+## Examples
+
+### ❌ Incorrect
+
+```json
+{
+  "name": "n8n-nodes-my-service",
+  "version": "1.0.0"
+}
+```
+
+```json
+{
+  "name": "n8n-nodes-my-service",
+  "license": "Apache-2.0"
+}
+```
+
+### ✅ Correct
+
+```json
+{
+  "name": "n8n-nodes-my-service",
+  "license": "MIT"
+}
+```

package/docs/rules/require-param-default.md

@@ -0,0 +1,60 @@
+# Require every node parameter to declare a default value (`@n8n/community-nodes/require-param-default`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+Every node parameter must declare a `default` property. A parameter is detected
+by its shape: an object inside the node's `description` with `displayName`,
+`name`, and `type` all set to string literals — the shape every
+`INodeProperties` entry has. Entries in an `options` array (which carry
+`name`/`value` but no `displayName`/`type`) are not treated as parameters.
+
+Without a `default`, n8n cannot reliably initialise the parameter's value. This
+leads to inconsistent behaviour in the editor (empty or `undefined` fields) and
+at execution time. Even non-input types such as `notice` are expected to declare
+`default: ''`.
+
+This rule also checks parameters nested inside `options` of `collection` and
+`fixedCollection` parameters.
+
+## Examples
+
+### Incorrect
+
+```typescript
+export class MyNode implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Node',
+    name: 'myNode',
+    properties: [
+      {
+        displayName: 'Field',
+        name: 'field',
+        type: 'string',
+      },
+    ],
+  };
+}
+```
+
+### Correct
+
+```typescript
+export class MyNode implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Node',
+    name: 'myNode',
+    properties: [
+      {
+        displayName: 'Field',
+        name: 'field',
+        type: 'string',
+        default: '',
+      },
+    ],
+  };
+}
+```

package/docs/rules/trigger-node-conventions.md

@@ -0,0 +1,49 @@
+# Trigger nodes (class name ends with `Trigger`) must label themselves consistently as triggers (`@n8n/community-nodes/trigger-node-conventions`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+When a node class name ends with `Trigger`, the node must consistently present
+itself as a trigger so users and the editor recognize it as one. This rule
+requires all of:
+
+- `description.name` ends with `Trigger`
+- `description.displayName` contains `Trigger`
+- `description.inputs` is an empty array (`[]`) — trigger nodes start an
+  execution and take no main inputs
+
+This consolidates three checks that form a single conceptual requirement: if
+it's a trigger node, label it consistently.
+
+## Examples
+
+### Incorrect
+
+```typescript
+export class MyTrigger implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Node',
+    name: 'my',
+    inputs: ['main'],
+    outputs: ['main'],
+    // ...
+  };
+}
+```
+
+### Correct
+
+```typescript
+export class MyTrigger implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Trigger',
+    name: 'myTrigger',
+    inputs: [],
+    outputs: ['main'],
+    // ...
+  };
+}
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@n8n/eslint-plugin-community-nodes",
   "type": "module",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "main": "./dist/plugin.js",
   "types": "./dist/plugin.d.ts",
   "exports": {
@@ -22,10 +22,11 @@
     "eslint-plugin-eslint-plugin": "^7.0.0",
     "rimraf": "6.0.1",
     "typescript": "6.0.2",
-    "vitest": "^4.1.1",
-    "@n8n/typescript-config": "1.6.0",
-    "@n8n/vitest-config": "1.15.0",
-    "n8n-workflow": "2.28.0"
+    "vite": "^8.0.2",
+    "vitest": "^4.1.9",
+    "@n8n/typescript-config": "1.7.0",
+    "@n8n/vitest-config": "1.16.0",
+    "n8n-workflow": "2.29.0"
   },
   "peerDependencies": {
     "eslint": "9.29.0",

package/src/plugin.ts

@@ -27,6 +27,8 @@ const configs = {
 			'@n8n/community-nodes/n8n-object-validation': 'error',
 			'@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
 			'@n8n/community-nodes/no-emoji-in-options': 'error',
+			'@n8n/community-nodes/no-asterisk-in-option-names': 'warn',
+			'@n8n/community-nodes/no-duplicate-param-options': 'warn',
 			'@n8n/community-nodes/node-usable-as-tool': 'error',
 			'@n8n/community-nodes/package-name-convention': 'error',
 			'@n8n/community-nodes/credential-test-required': 'error',
@@ -41,6 +43,7 @@ const configs = {
 			'@n8n/community-nodes/icon-prefer-themed-variants': 'warn',
 			'@n8n/community-nodes/options-sorted-alphabetically': 'warn',
 			'@n8n/community-nodes/resource-operation-pattern': 'warn',
+			'@n8n/community-nodes/trigger-node-conventions': 'error',
 			'@n8n/community-nodes/credential-documentation-url': 'error',
 			'@n8n/community-nodes/cred-class-field-icon-missing': 'error',
 			'@n8n/community-nodes/cred-class-name-field-conventions': 'error',
@@ -56,8 +59,10 @@ const configs = {
 			'@n8n/community-nodes/node-registration-complete': 'warn',
 			'@n8n/community-nodes/require-community-node-keyword': 'warn',
 			'@n8n/community-nodes/require-continue-on-fail': 'error',
+			'@n8n/community-nodes/require-mit-license': 'error',
 			'@n8n/community-nodes/require-node-api-error': 'error',
 			'@n8n/community-nodes/require-node-description-fields': 'error',
+			'@n8n/community-nodes/require-param-default': 'error',
 			'@n8n/community-nodes/require-version': 'error',
 			'@n8n/community-nodes/valid-author': 'error',
 			'@n8n/community-nodes/valid-credential-references': 'error',
@@ -77,6 +82,8 @@ const configs = {
 			'@n8n/community-nodes/n8n-object-validation': 'error',
 			'@n8n/community-nodes/no-deprecated-workflow-functions': 'error',
 			'@n8n/community-nodes/no-emoji-in-options': 'error',
+			'@n8n/community-nodes/no-asterisk-in-option-names': 'warn',
+			'@n8n/community-nodes/no-duplicate-param-options': 'warn',
 			'@n8n/community-nodes/node-usable-as-tool': 'error',
 			'@n8n/community-nodes/package-name-convention': 'error',
 			'@n8n/community-nodes/credential-test-required': 'error',
@@ -92,6 +99,7 @@ const configs = {
 			'@n8n/community-nodes/options-sorted-alphabetically': 'warn',
 			'@n8n/community-nodes/credential-documentation-url': 'error',
 			'@n8n/community-nodes/resource-operation-pattern': 'warn',
+			'@n8n/community-nodes/trigger-node-conventions': 'error',
 			'@n8n/community-nodes/cred-class-field-icon-missing': 'error',
 			'@n8n/community-nodes/cred-class-name-field-conventions': 'error',
 			'@n8n/community-nodes/cred-class-name-suffix': 'error',
@@ -106,8 +114,10 @@ const configs = {
 			'@n8n/community-nodes/node-registration-complete': 'warn',
 			'@n8n/community-nodes/require-community-node-keyword': 'warn',
 			'@n8n/community-nodes/require-continue-on-fail': 'error',
+			'@n8n/community-nodes/require-mit-license': 'error',
 			'@n8n/community-nodes/require-node-api-error': 'error',
 			'@n8n/community-nodes/require-node-description-fields': 'error',
+			'@n8n/community-nodes/require-param-default': 'error',
 			'@n8n/community-nodes/require-version': 'error',
 			'@n8n/community-nodes/valid-author': 'error',
 			'@n8n/community-nodes/valid-credential-references': 'error',

package/src/rules/index.ts

@@ -13,10 +13,12 @@ import { IconPreferThemedVariantsRule } from './icon-prefer-themed-variants.js';
 import { IconValidationRule } from './icon-validation.js';
 import { MissingPairedItemRule } from './missing-paired-item.js';
 import { N8nObjectValidationRule } from './n8n-object-validation.js';
+import { NoAsteriskInOptionNamesRule } from './no-asterisk-in-option-names.js';
 import { NoBuilderHintLeakageRule } from './no-builder-hint-leakage.js';
 import { NoCredentialReuseRule } from './no-credential-reuse.js';
 import { NoDangerousFunctionsRule } from './no-dangerous-functions.js';
 import { NoDeprecatedWorkflowFunctionsRule } from './no-deprecated-workflow-functions.js';
+import { NoDuplicateParamOptionsRule } from './no-duplicate-param-options.js';
 import { NoEmojiInOptionsRule } from './no-emoji-in-options.js';
 import { NoForbiddenLifecycleScriptsRule } from './no-forbidden-lifecycle-scripts.js';
 import { NoHttpRequestWithManualAuthRule } from './no-http-request-with-manual-auth.js';
@@ -36,10 +38,13 @@ import { OptionsSortedAlphabeticallyRule } from './options-sorted-alphabetically
 import { PackageNameConventionRule } from './package-name-convention.js';
 import { RequireCommunityNodeKeywordRule } from './require-community-node-keyword.js';
 import { RequireContinueOnFailRule } from './require-continue-on-fail.js';
+import { RequireMitLicenseRule } from './require-mit-license.js';
 import { RequireNodeApiErrorRule } from './require-node-api-error.js';
 import { RequireNodeDescriptionFieldsRule } from './require-node-description-fields.js';
+import { RequireParamDefaultRule } from './require-param-default.js';
 import { RequireVersionRule } from './require-version.js';
 import { ResourceOperationPatternRule } from './resource-operation-pattern.js';
+import { TriggerNodeConventionsRule } from './trigger-node-conventions.js';
 import { ValidAuthorRule } from './valid-author.js';
 import { ValidCredentialReferencesRule } from './valid-credential-references.js';
 import { ValidDescriptionRule } from './valid-description.js';
@@ -53,6 +58,8 @@ export const rules = {
 	'credential-password-field': CredentialPasswordFieldRule,
 	'no-deprecated-workflow-functions': NoDeprecatedWorkflowFunctionsRule,
 	'no-emoji-in-options': NoEmojiInOptionsRule,
+	'no-asterisk-in-option-names': NoAsteriskInOptionNamesRule,
+	'no-duplicate-param-options': NoDuplicateParamOptionsRule,
 	'node-usable-as-tool': NodeUsableAsToolRule,
 	'options-sorted-alphabetically': OptionsSortedAlphabeticallyRule,
 	'package-name-convention': PackageNameConventionRule,
@@ -67,6 +74,7 @@ export const rules = {
 	'icon-validation': IconValidationRule,
 	'icon-prefer-themed-variants': IconPreferThemedVariantsRule,
 	'resource-operation-pattern': ResourceOperationPatternRule,
+	'trigger-node-conventions': TriggerNodeConventionsRule,
 	'credential-documentation-url': CredentialDocumentationUrlRule,
 	'node-class-description-icon-missing': NodeClassDescriptionIconMissingRule,
 	'node-class-description-name-camelcase': NodeClassDescriptionNameCamelCaseRule,
@@ -84,8 +92,10 @@ export const rules = {
 	'n8n-object-validation': N8nObjectValidationRule,
 	'require-community-node-keyword': RequireCommunityNodeKeywordRule,
 	'require-continue-on-fail': RequireContinueOnFailRule,
+	'require-mit-license': RequireMitLicenseRule,
 	'require-node-api-error': RequireNodeApiErrorRule,
 	'require-node-description-fields': RequireNodeDescriptionFieldsRule,
+	'require-param-default': RequireParamDefaultRule,
 	'require-version': RequireVersionRule,
 	'valid-author': ValidAuthorRule,
 	'valid-credential-references': ValidCredentialReferencesRule,

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

@@ -0,0 +1,185 @@
+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

@@ -0,0 +1,111 @@
+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);
+			},
+		};
+	},
+});