@n8n/eslint-plugin-community-nodes 0.21.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/node-class-description-name-camelcase.md

@@ -0,0 +1,41 @@
+# Node class `description.name` must be camelCase (`@n8n/community-nodes/node-class-description-name-camelcase`)
+
+💼 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
+
+The `name` field inside a node class `description` (those implementing `INodeType` or extending `Node` in `*.node.ts` files) is the internal identifier used to register and reference the node. n8n convention requires this identifier to be camelCase: it must start with a lowercase letter and contain only letters and digits, with no spaces, hyphens, underscores, or other separators.
+
+The value must match `^[a-z][a-zA-Z0-9]*$`.
+
+The rule is automatically fixable: separators are removed, each subsequent word is upper-cased, and the first character is lower-cased (e.g. `My Node` → `myNode`). Names that cannot be repaired into a valid identifier (for example, those starting with a digit) are reported without an autofix.
+
+## Examples
+
+### ❌ Incorrect
+
+```typescript
+export class MyNode implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Node',
+    name: 'My Node',
+    // ...
+  };
+}
+```
+
+### ✅ Correct
+
+```typescript
+export class MyNode implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Node',
+    name: 'myNode',
+    // ...
+  };
+}
+```

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/docs/rules/valid-peer-dependencies.md

@@ -1,4 +1,4 @@
-# Require community node package.json peerDependencies to contain only "n8n-workflow": "*" (and optionally "ai-node-sdk") (`@n8n/community-nodes/valid-peer-dependencies`)
+# Require community node package.json peerDependencies to contain only "n8n-workflow": "*" (and optionally "@n8n/ai-node-sdk") (`@n8n/community-nodes/valid-peer-dependencies`)
 
 💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@n8n/eslint-plugin-community-nodes",
   "type": "module",
-  "version": "0.21.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.27.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',
@@ -48,6 +51,7 @@ const configs = {
 			'@n8n/community-nodes/cred-class-oauth2-naming': 'error',
 			'@n8n/community-nodes/cred-filename-against-convention': 'error',
 			'@n8n/community-nodes/node-connection-type-literal': 'error',
+			'@n8n/community-nodes/node-class-description-name-camelcase': 'error',
 			'@n8n/community-nodes/node-filename-against-convention': 'error',
 			'@n8n/community-nodes/missing-paired-item': 'error',
 			'@n8n/community-nodes/no-builder-hint-leakage': 'error',
@@ -55,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',
@@ -76,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',
@@ -91,12 +99,14 @@ 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',
 			'@n8n/community-nodes/cred-class-oauth2-naming': 'error',
 			'@n8n/community-nodes/cred-filename-against-convention': 'error',
 			'@n8n/community-nodes/node-connection-type-literal': 'error',
+			'@n8n/community-nodes/node-class-description-name-camelcase': 'error',
 			'@n8n/community-nodes/node-filename-against-convention': 'error',
 			'@n8n/community-nodes/missing-paired-item': 'error',
 			'@n8n/community-nodes/no-builder-hint-leakage': 'error',
@@ -104,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/ai-node-package-json.test.ts

@@ -11,6 +11,11 @@ ruleTester.run('ai-node-package-json', AiNodePackageJsonRule, {
 			filename: 'package.json',
 			code: '{ "name": "n8n-nodes-example", "n8n": { "aiNodeSdkVersion": 1 }, "peerDependencies": { "n8n-workflow": "*", "ai-node-sdk": "*" } }',
 		},
+		{
+			name: 'both n8n.aiNodeSdkVersion and scoped @n8n/ai-node-sdk peer dependency present',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "n8n": { "aiNodeSdkVersion": 1 }, "peerDependencies": { "n8n-workflow": "*", "@n8n/ai-node-sdk": "*" } }',
+		},
 		{
 			name: 'neither n8n.aiNodeSdkVersion nor ai-node-sdk present (non-AI package)',
 			filename: 'package.json',

package/src/rules/ai-node-package-json.ts

@@ -13,9 +13,9 @@ export const AiNodePackageJsonRule = createRule({
 		},
 		messages: {
 			missingPeerDep:
-				'Package declares "n8n.aiNodeSdkVersion" but is missing "ai-node-sdk" in peerDependencies. Add "ai-node-sdk": "*" to peerDependencies.',
+				'Package declares "n8n.aiNodeSdkVersion" but is missing "@n8n/ai-node-sdk" in peerDependencies. Add "@n8n/ai-node-sdk": "*" to peerDependencies.',
 			missingSdkVersion:
-				'Package has "ai-node-sdk" in peerDependencies but is missing "aiNodeSdkVersion" in the "n8n" section of package.json.',
+				'Package has "@n8n/ai-node-sdk" in peerDependencies but is missing "aiNodeSdkVersion" in the "n8n" section of package.json.',
 			invalidSdkVersion: '"n8n.aiNodeSdkVersion" must be a positive integer, got {{ value }}.',
 			wrongLocation:
 				'"aiNodeSdkVersion" must be inside the "n8n" section, not at the root level of package.json.',
@@ -49,7 +49,8 @@ export const AiNodePackageJsonRule = createRule({
 				const hasAiNodeSdkVersion = aiNodeSdkVersionProp !== null;
 				const hasAiNodeSdkPeerDep =
 					peerDependenciesProp?.value.type === AST_NODE_TYPES.ObjectExpression &&
-					findJsonProperty(peerDependenciesProp.value, 'ai-node-sdk') !== null;
+					(findJsonProperty(peerDependenciesProp.value, '@n8n/ai-node-sdk') !== null ||
+						findJsonProperty(peerDependenciesProp.value, 'ai-node-sdk') !== null);
 
 				// Catch aiNodeSdkVersion placed at root level instead of inside n8n
 				if (rootAiNodeSdkVersionProp) {

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';
@@ -26,6 +28,7 @@ import { NoRestrictedImportsRule } from './no-restricted-imports.js';
 import { NoRuntimeDependenciesRule } from './no-runtime-dependencies.js';
 import { NoTemplatePlaceholdersRule } from './no-template-placeholders.js';
 import { NodeClassDescriptionIconMissingRule } from './node-class-description-icon-missing.js';
+import { NodeClassDescriptionNameCamelCaseRule } from './node-class-description-name-camelcase.js';
 import { NodeConnectionTypeLiteralRule } from './node-connection-type-literal.js';
 import { NodeFilenameAgainstConventionRule } from './node-filename-against-convention.js';
 import { NodeOperationErrorItemIndexRule } from './node-operation-error-itemindex.js';
@@ -35,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';
@@ -52,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,
@@ -66,8 +74,10 @@ 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,
 	'cred-class-field-icon-missing': CredClassFieldIconMissingRule,
 	'cred-class-name-field-conventions': CredClassNameFieldConventionsRule,
 	'cred-class-name-suffix': CredClassNameSuffixRule,
@@ -82,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,