@n8n/eslint-plugin-community-nodes 0.13.0 → 0.14.0

package/dist/rules/webhook-lifecycle-complete.d.ts

@@ -0,0 +1,2 @@
+export declare const WebhookLifecycleCompleteRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingWebhookMethods" | "missingLifecycleMethod", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+//# sourceMappingURL=webhook-lifecycle-complete.d.ts.map

package/dist/rules/webhook-lifecycle-complete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-lifecycle-complete.d.ts","sourceRoot":"","sources":["../../src/rules/webhook-lifecycle-complete.ts"],"names":[],"mappings":"AA+CA,eAAO,MAAM,4BAA4B,qLAwEvC,CAAC"}

package/dist/rules/webhook-lifecycle-complete.js

@@ -0,0 +1,98 @@
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { createRule, findClassProperty, findObjectProperty, isNodeTypeClass, } from '../utils/index.js';
+const REQUIRED_METHODS = ['checkExists', 'create', 'delete'];
+/**
+ * Returns true if the description declares webhook endpoints, indicating the
+ * node is a webhook-based trigger that needs a complete lifecycle.
+ *
+ * Polling triggers (group `['trigger']` without a `webhooks` array) do not
+ * register remote webhooks and are intentionally out of scope.
+ */
+function hasWebhooksDeclared(descriptionValue) {
+    const webhooksProperty = findObjectProperty(descriptionValue, 'webhooks');
+    if (webhooksProperty?.value.type !== AST_NODE_TYPES.ArrayExpression)
+        return false;
+    return webhooksProperty.value.elements.length > 0;
+}
+/** Returns true when the property defines a (possibly async) method named `name`. */
+function isMethodProperty(property, name) {
+    if (property.type !== AST_NODE_TYPES.Property)
+        return false;
+    if (property.computed)
+        return false;
+    const keyMatches = (property.key.type === AST_NODE_TYPES.Identifier && property.key.name === name) ||
+        (property.key.type === AST_NODE_TYPES.Literal && property.key.value === name);
+    if (!keyMatches)
+        return false;
+    return (property.value.type === AST_NODE_TYPES.FunctionExpression ||
+        property.value.type === AST_NODE_TYPES.ArrowFunctionExpression);
+}
+function findMissingMethods(group) {
+    return REQUIRED_METHODS.filter((method) => !group.properties.some((property) => isMethodProperty(property, method)));
+}
+export const WebhookLifecycleCompleteRule = createRule({
+    name: 'webhook-lifecycle-complete',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Require webhook trigger nodes to implement the complete webhookMethods lifecycle (checkExists, create, delete)',
+        },
+        messages: {
+            missingWebhookMethods: 'Webhook trigger node is missing the `webhookMethods` property. Implement `checkExists`, `create`, and `delete` to register, verify, and clean up the webhook on the third-party service.',
+            missingLifecycleMethod: 'Webhook trigger lifecycle is incomplete. `webhookMethods.{{group}}` is missing: {{missing}}. All of `checkExists`, `create`, and `delete` must be implemented.',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        return {
+            ClassDeclaration(node) {
+                if (!isNodeTypeClass(node))
+                    return;
+                const descriptionProperty = findClassProperty(node, 'description');
+                if (!descriptionProperty)
+                    return;
+                const descriptionValue = descriptionProperty.value;
+                if (descriptionValue?.type !== AST_NODE_TYPES.ObjectExpression)
+                    return;
+                const webhookMethodsProperty = findClassProperty(node, 'webhookMethods');
+                if (!hasWebhooksDeclared(descriptionValue) && !webhookMethodsProperty) {
+                    return;
+                }
+                if (!webhookMethodsProperty?.value) {
+                    context.report({
+                        node: node.id ?? node,
+                        messageId: 'missingWebhookMethods',
+                    });
+                    return;
+                }
+                if (webhookMethodsProperty.value.type !== AST_NODE_TYPES.ObjectExpression) {
+                    return;
+                }
+                for (const groupProperty of webhookMethodsProperty.value.properties) {
+                    if (groupProperty.type !== AST_NODE_TYPES.Property)
+                        continue;
+                    if (groupProperty.value.type !== AST_NODE_TYPES.ObjectExpression)
+                        continue;
+                    const groupName = groupProperty.key.type === AST_NODE_TYPES.Identifier
+                        ? groupProperty.key.name
+                        : groupProperty.key.type === AST_NODE_TYPES.Literal
+                            ? String(groupProperty.key.value)
+                            : 'default';
+                    const missing = findMissingMethods(groupProperty.value);
+                    if (missing.length === 0)
+                        continue;
+                    context.report({
+                        node: groupProperty.key,
+                        messageId: 'missingLifecycleMethod',
+                        data: {
+                            group: groupName,
+                            missing: missing.map((m) => `\`${m}\``).join(', '),
+                        },
+                    });
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=webhook-lifecycle-complete.js.map

package/dist/rules/webhook-lifecycle-complete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-lifecycle-complete.js","sourceRoot":"","sources":["../../src/rules/webhook-lifecycle-complete.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAiB,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,GACf,MAAM,mBAAmB,CAAC;AAE3B,MAAM,gBAAgB,GAAG,CAAC,aAAa,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAC;AAGtE;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,gBAA2C;IACvE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;IAC1E,IAAI,gBAAgB,EAAE,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe;QAAE,OAAO,KAAK,CAAC;IAClF,OAAO,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;AACnD,CAAC;AAED,qFAAqF;AACrF,SAAS,gBAAgB,CAAC,QAAuC,EAAE,IAAY;IAC9E,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5D,IAAI,QAAQ,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IAEpC,MAAM,UAAU,GACf,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;QAC/E,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;IAC/E,IAAI,CAAC,UAAU;QAAE,OAAO,KAAK,CAAC;IAE9B,OAAO,CACN,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB;QACzD,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB,CAC9D,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAgC;IAC3D,OAAO,gBAAgB,CAAC,MAAM,CAC7B,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CACpF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,MAAM,4BAA4B,GAAG,UAAU,CAAC;IACtD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EACV,gHAAgH;SACjH;QACD,QAAQ,EAAE;YACT,qBAAqB,EACpB,0LAA0L;YAC3L,sBAAsB,EACrB,gKAAgK;SACjK;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,OAAO;YACN,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;oBAAE,OAAO;gBAEnC,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBACnE,IAAI,CAAC,mBAAmB;oBAAE,OAAO;gBAEjC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,KAAK,CAAC;gBACnD,IAAI,gBAAgB,EAAE,IAAI,KAAK,cAAc,CAAC,gBAAgB;oBAAE,OAAO;gBAEvE,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;gBAEzE,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;oBACvE,OAAO;gBACR,CAAC;gBAED,IAAI,CAAC,sBAAsB,EAAE,KAAK,EAAE,CAAC;oBACpC,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,IAAI;wBACrB,SAAS,EAAE,uBAAuB;qBAClC,CAAC,CAAC;oBACH,OAAO;gBACR,CAAC;gBAED,IAAI,sBAAsB,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;oBAC3E,OAAO;gBACR,CAAC;gBAED,KAAK,MAAM,aAAa,IAAI,sBAAsB,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;oBACrE,IAAI,aAAa,CAAC,IAAI,KAAK,cAAc,CAAC,QAAQ;wBAAE,SAAS;oBAC7D,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;wBAAE,SAAS;oBAE3E,MAAM,SAAS,GACd,aAAa,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;wBACnD,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI;wBACxB,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO;4BAClD,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC;4BACjC,CAAC,CAAC,SAAS,CAAC;oBAEf,MAAM,OAAO,GAAG,kBAAkB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;oBACxD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;wBAAE,SAAS;oBAEnC,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI,EAAE,aAAa,CAAC,GAAG;wBACvB,SAAS,EAAE,wBAAwB;wBACnC,IAAI,EAAE;4BACL,KAAK,EAAE,SAAS;4BAChB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;yBAClD;qBACD,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}

package/docs/rules/no-overrides-field.md

@@ -0,0 +1,50 @@
+# Ban the "overrides" field in community node package.json (`@n8n/community-nodes/no-overrides-field`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+The `overrides` field in `package.json` lets a package force specific versions of its (transitive) dependencies. In the context of n8n community nodes this is dangerous:
+
+- Community nodes are installed into a shared n8n runtime alongside other nodes. Overriding a shared library (e.g. `axios`, `@langchain/core`, `minimatch`) can silently substitute an incompatible version for every other node that depends on it, causing hard-to-diagnose runtime failures.
+- Community nodes are distributed as pre-built packages with their dependencies already bundled or declared as `peerDependencies`. Any version pinning that the node actually needs should happen during development, not at install time on the user's n8n instance.
+- `overrides` is frequently copy-pasted from an unrelated internal project and is almost never intentional in a community node.
+
+If you have a genuine compatibility need, bundle the dependency into the published artifact or declare it via `peerDependencies` instead.
+
+## Examples
+
+### Incorrect
+
+```json
+{
+  "name": "n8n-nodes-example",
+  "overrides": {
+    "axios": "1.7.0"
+  }
+}
+```
+
+```json
+{
+  "name": "n8n-nodes-example",
+  "overrides": {
+    "axios": "1.7.0",
+    "@langchain/core": "0.3.0",
+    "minimatch": "9.0.5"
+  }
+}
+```
+
+### Correct
+
+```json
+{
+  "name": "n8n-nodes-example",
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}
+```

package/docs/rules/node-class-description-icon-missing.md

@@ -1,11 +1,13 @@
-# Node class description must have an `icon` property defined (`@n8n/community-nodes/node-class-description-icon-missing`)
+# Node class description must have an `icon` property defined. Deprecated: use `require-node-description-fields` instead (`@n8n/community-nodes/node-class-description-icon-missing`)
 
-❌ This rule is **deprecated**. Use [`require-node-description-fields`](require-node-description-fields.md) instead.
+❌ This rule is deprecated.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 
+> **Deprecated:** Use [`require-node-description-fields`](require-node-description-fields.md) instead.
+
 ## Rule Details
 
 Validates that node classes define an `icon` property in their `description` object. Icons are required for nodes to display correctly in the n8n editor.

package/docs/rules/require-community-node-keyword.md

@@ -1,8 +1,8 @@
-# Require the "n8n-community-node-package" keyword in package.json (`@n8n/community-nodes/require-community-node-keyword`)
+# Require the "n8n-community-node-package" keyword in community node package.json (`@n8n/community-nodes/require-community-node-keyword`)
 
-⚠️ This rule is set to `warn` in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+⚠️ This rule _warns_ in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
 
-🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/use/command-line-interface#--fix).
+🔧 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 -->
 

package/docs/rules/require-node-api-error.md

@@ -0,0 +1,62 @@
+# Require NodeApiError or NodeOperationError for error wrapping in catch blocks. Raw errors lose HTTP context in the n8n UI (`@n8n/community-nodes/require-node-api-error`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+When errors are caught and re-thrown in n8n nodes, they must be wrapped in
+`NodeApiError` or `NodeOperationError`. Raw re-throws and generic `Error`
+constructors lose HTTP context (status code, response body, etc.) that the n8n
+UI relies on to display meaningful error information to users.
+
+## Examples
+
+### Incorrect
+
+```js
+try {
+  await apiRequest();
+} catch (error) {
+  throw error;
+}
+```
+
+```js
+try {
+  await apiRequest();
+} catch (error) {
+  throw new Error('Request failed');
+}
+```
+
+### Correct
+
+```js
+try {
+  await apiRequest();
+} catch (error) {
+  throw new NodeApiError(this.getNode(), error as JsonObject);
+}
+```
+
+```js
+try {
+  await apiRequest();
+} catch (error) {
+  throw new NodeOperationError(this.getNode(), 'Operation failed', { itemIndex: i });
+}
+```
+
+```js
+try {
+  await apiRequest();
+} catch (error) {
+  if (this.continueOnFail()) {
+    returnData.push({ json: { error: error.message } });
+    continue;
+  }
+  throw new NodeApiError(this.getNode(), error as JsonObject);
+}
+```

package/docs/rules/require-node-description-fields.md

@@ -1,4 +1,4 @@
-# Node class description must define all required fields (`@n8n/community-nodes/require-node-description-fields`)
+# Node class description must define all required fields: icon, subtitle (`@n8n/community-nodes/require-node-description-fields`)
 
 💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
 

package/docs/rules/valid-peer-dependencies.md

@@ -0,0 +1,72 @@
+# Require community node package.json peerDependencies to contain only "n8n-workflow": "*" (and optionally "ai-node-sdk") (`@n8n/community-nodes/valid-peer-dependencies`)
+
+💼 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
+
+Community node packages must declare their n8n integration via `peerDependencies` so that they resolve against the host n8n installation rather than bundling their own copy. The only permitted entries are:
+
+- `n8n-workflow` — required, must be exactly `"*"` (no pinned or ranged versions)
+- `ai-node-sdk` — optional, present only for AI nodes (its shape is validated by [`ai-node-package-json`](ai-node-package-json.md))
+
+Any other entry (notably `n8n-core`) is flagged because it causes duplicate or incompatible copies of n8n internals to be loaded at runtime.
+
+The rule checks:
+
+- `peerDependencies` is present in `package.json`
+- `n8n-workflow` is listed with value `"*"`
+- No other packages (besides `ai-node-sdk`) appear in `peerDependencies`
+
+## Examples
+
+### ❌ Incorrect
+
+```json
+{
+  "name": "n8n-nodes-example"
+}
+```
+
+```json
+{
+  "name": "n8n-nodes-example",
+  "peerDependencies": {
+    "n8n-workflow": "^1.0.0"
+  }
+}
+```
+
+```json
+{
+  "name": "n8n-nodes-example",
+  "peerDependencies": {
+    "n8n-workflow": "*",
+    "n8n-core": "*"
+  }
+}
+```
+
+### ✅ Correct
+
+```json
+{
+  "name": "n8n-nodes-example",
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}
+```
+
+```json
+{
+  "name": "n8n-nodes-my-ai-node",
+  "peerDependencies": {
+    "n8n-workflow": "*",
+    "ai-node-sdk": "*"
+  }
+}
+```

package/docs/rules/webhook-lifecycle-complete.md

@@ -0,0 +1,88 @@
+# Require webhook trigger nodes to implement the complete webhookMethods lifecycle (checkExists, create, delete) (`@n8n/community-nodes/webhook-lifecycle-complete`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+Webhook-based trigger nodes must implement a complete webhook lifecycle so that
+n8n can register, verify, and clean up webhooks on the third-party service.
+Missing any of the three methods results in leaked webhooks, duplicated
+registrations, or workflows that silently stop firing.
+
+This rule applies to node classes that:
+
+- declare a non-empty `webhooks` array in their `description`, or
+- define a `webhookMethods` class property.
+
+For every webhook group inside `webhookMethods` (typically `default`), the
+methods `checkExists`, `create`, and `delete` must all be implemented.
+
+Polling triggers (trigger nodes without a `webhooks` array and without
+`webhookMethods`) are intentionally out of scope.
+
+## Examples
+
+### ❌ Incorrect
+
+Webhook trigger without any lifecycle methods:
+
+```typescript
+export class MyTrigger implements INodeType {
+  description: INodeTypeDescription = {
+    displayName: 'My Trigger',
+    name: 'myTrigger',
+    group: ['trigger'],
+    version: 1,
+    description: 'Trigger on events',
+    defaults: { name: 'My Trigger' },
+    inputs: [],
+    outputs: ['main'],
+    webhooks: [
+      { name: 'default', httpMethod: 'POST', responseMode: 'onReceived', path: 'webhook' },
+    ],
+    properties: [],
+  };
+}
+```
+
+Webhook trigger with an incomplete `webhookMethods.default`:
+
+```typescript
+export class MyTrigger implements INodeType {
+  description: INodeTypeDescription = { /* ... */ };
+
+  webhookMethods = {
+    default: {
+      async create(this: IHookFunctions): Promise<boolean> { /* ... */ return true; },
+      // Missing checkExists and delete
+    },
+  };
+}
+```
+
+### ✅ Correct
+
+```typescript
+export class MyTrigger implements INodeType {
+  description: INodeTypeDescription = { /* ... */ };
+
+  webhookMethods = {
+    default: {
+      async checkExists(this: IHookFunctions): Promise<boolean> {
+        // Return true if the webhook is already registered on the third-party service.
+        return true;
+      },
+      async create(this: IHookFunctions): Promise<boolean> {
+        // Register the webhook with the third-party service and persist any IDs.
+        return true;
+      },
+      async delete(this: IHookFunctions): Promise<boolean> {
+        // Remove the webhook from the third-party service.
+        return true;
+      },
+    },
+  };
+}
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@n8n/eslint-plugin-community-nodes",
   "type": "module",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "main": "./dist/plugin.js",
   "types": "./dist/plugin.d.ts",
   "exports": {
@@ -23,8 +23,8 @@
     "typescript": "6.0.2",
     "vitest": "^4.1.1",
     "@n8n/typescript-config": "1.4.0",
-    "n8n-workflow": "2.18.0",
-    "@n8n/vitest-config": "1.9.0"
+    "n8n-workflow": "2.19.0",
+    "@n8n/vitest-config": "1.10.0"
   },
   "peerDependencies": {
     "eslint": ">= 9",
@@ -54,14 +54,14 @@
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
-    "build:docs": "eslint-doc-generator",
+    "build:docs": "pnpm build && eslint-doc-generator",
     "clean": "rimraf dist .turbo",
     "dev": "pnpm watch",
     "format": "biome format --write .",
     "format:check": "biome ci .",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
-    "lint:docs": "eslint-doc-generator --check",
+    "lint:docs": "pnpm build && eslint-doc-generator --check",
     "test": "vitest run",
     "test:unit": "vitest run",
     "test:dev": "vitest",

package/src/plugin.ts

@@ -31,6 +31,7 @@ const configs = {
 			'@n8n/community-nodes/no-credential-reuse': 'error',
 			'@n8n/community-nodes/no-forbidden-lifecycle-scripts': 'error',
 			'@n8n/community-nodes/no-http-request-with-manual-auth': 'error',
+			'@n8n/community-nodes/no-overrides-field': 'error',
 			'@n8n/community-nodes/icon-validation': 'error',
 			'@n8n/community-nodes/options-sorted-alphabetically': 'warn',
 			'@n8n/community-nodes/resource-operation-pattern': 'warn',
@@ -40,7 +41,10 @@ const configs = {
 			'@n8n/community-nodes/missing-paired-item': 'error',
 			'@n8n/community-nodes/require-community-node-keyword': 'warn',
 			'@n8n/community-nodes/require-continue-on-fail': 'error',
+			'@n8n/community-nodes/require-node-api-error': 'error',
 			'@n8n/community-nodes/require-node-description-fields': 'error',
+			'@n8n/community-nodes/valid-peer-dependencies': 'error',
+			'@n8n/community-nodes/webhook-lifecycle-complete': 'error',
 		},
 	},
 	recommendedWithoutN8nCloudSupport: {
@@ -58,6 +62,7 @@ const configs = {
 			'@n8n/community-nodes/no-credential-reuse': 'error',
 			'@n8n/community-nodes/no-forbidden-lifecycle-scripts': 'error',
 			'@n8n/community-nodes/no-http-request-with-manual-auth': 'error',
+			'@n8n/community-nodes/no-overrides-field': 'error',
 			'@n8n/community-nodes/icon-validation': 'error',
 			'@n8n/community-nodes/options-sorted-alphabetically': 'warn',
 			'@n8n/community-nodes/credential-documentation-url': 'error',
@@ -67,7 +72,10 @@ const configs = {
 			'@n8n/community-nodes/missing-paired-item': 'error',
 			'@n8n/community-nodes/require-community-node-keyword': 'warn',
 			'@n8n/community-nodes/require-continue-on-fail': 'error',
+			'@n8n/community-nodes/require-node-api-error': 'error',
 			'@n8n/community-nodes/require-node-description-fields': 'error',
+			'@n8n/community-nodes/valid-peer-dependencies': 'error',
+			'@n8n/community-nodes/webhook-lifecycle-complete': 'error',
 		},
 	},
 } satisfies Record<string, Linter.Config>;

package/src/rules/index.ts

@@ -11,6 +11,7 @@ import { NoCredentialReuseRule } from './no-credential-reuse.js';
 import { NoDeprecatedWorkflowFunctionsRule } from './no-deprecated-workflow-functions.js';
 import { NoForbiddenLifecycleScriptsRule } from './no-forbidden-lifecycle-scripts.js';
 import { NoHttpRequestWithManualAuthRule } from './no-http-request-with-manual-auth.js';
+import { NoOverridesFieldRule } from './no-overrides-field.js';
 import { NoRestrictedGlobalsRule } from './no-restricted-globals.js';
 import { NoRestrictedImportsRule } from './no-restricted-imports.js';
 import { NodeClassDescriptionIconMissingRule } from './node-class-description-icon-missing.js';
@@ -20,8 +21,11 @@ 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 { RequireNodeApiErrorRule } from './require-node-api-error.js';
 import { RequireNodeDescriptionFieldsRule } from './require-node-description-fields.js';
 import { ResourceOperationPatternRule } from './resource-operation-pattern.js';
+import { ValidPeerDependenciesRule } from './valid-peer-dependencies.js';
+import { WebhookLifecycleCompleteRule } from './webhook-lifecycle-complete.js';
 
 export const rules = {
 	'ai-node-package-json': AiNodePackageJsonRule,
@@ -36,6 +40,7 @@ export const rules = {
 	'no-credential-reuse': NoCredentialReuseRule,
 	'no-forbidden-lifecycle-scripts': NoForbiddenLifecycleScriptsRule,
 	'no-http-request-with-manual-auth': NoHttpRequestWithManualAuthRule,
+	'no-overrides-field': NoOverridesFieldRule,
 	'icon-validation': IconValidationRule,
 	'resource-operation-pattern': ResourceOperationPatternRule,
 	'credential-documentation-url': CredentialDocumentationUrlRule,
@@ -45,5 +50,8 @@ export const rules = {
 	'missing-paired-item': MissingPairedItemRule,
 	'require-community-node-keyword': RequireCommunityNodeKeywordRule,
 	'require-continue-on-fail': RequireContinueOnFailRule,
+	'require-node-api-error': RequireNodeApiErrorRule,
 	'require-node-description-fields': RequireNodeDescriptionFieldsRule,
+	'valid-peer-dependencies': ValidPeerDependenciesRule,
+	'webhook-lifecycle-complete': WebhookLifecycleCompleteRule,
 } satisfies Record<string, AnyRuleModule>;

package/src/rules/no-overrides-field.test.ts

@@ -0,0 +1,50 @@
+import { RuleTester } from '@typescript-eslint/rule-tester';
+
+import { NoOverridesFieldRule } from './no-overrides-field.js';
+
+const ruleTester = new RuleTester();
+
+ruleTester.run('no-overrides-field', NoOverridesFieldRule, {
+	valid: [
+		{
+			name: 'no overrides field',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "version": "1.0.0" }',
+		},
+		{
+			name: 'package.json with dependencies but no overrides',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "peerDependencies": { "n8n-workflow": "*" } }',
+		},
+		{
+			name: 'non-package.json file is ignored',
+			filename: 'some-config.json',
+			code: '{ "overrides": { "axios": "1.0.0" } }',
+		},
+		{
+			name: 'nested "overrides" key inside another field is allowed',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "config": { "overrides": { "axios": "1.0.0" } } }',
+		},
+	],
+	invalid: [
+		{
+			name: 'overrides as object is forbidden',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "overrides": { "axios": "1.0.0" } }',
+			errors: [{ messageId: 'overridesForbidden' }],
+		},
+		{
+			name: 'empty overrides object is forbidden',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-example", "overrides": {} }',
+			errors: [{ messageId: 'overridesForbidden' }],
+		},
+		{
+			name: 'real-world overrides (CNOC-404 Sinch) is forbidden',
+			filename: 'package.json',
+			code: '{ "name": "n8n-nodes-sinch", "overrides": { "axios": "1.7.0", "fast-xml-parser": "4.4.0", "minimatch": "9.0.5", "@langchain/core": "0.3.0", "qs": "6.13.0" } }',
+			errors: [{ messageId: 'overridesForbidden' }],
+		},
+	],
+});

package/src/rules/no-overrides-field.ts

@@ -0,0 +1,43 @@
+import type { TSESTree } from '@typescript-eslint/utils';
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+
+import { createRule, findJsonProperty } from '../utils/index.js';
+
+export const NoOverridesFieldRule = createRule({
+	name: 'no-overrides-field',
+	meta: {
+		type: 'problem',
+		docs: {
+			description: 'Ban the "overrides" field in community node package.json',
+		},
+		messages: {
+			overridesForbidden:
+				'The "overrides" field is not allowed in community node packages. Dependency overrides can introduce incompatible versions of shared libraries into the n8n runtime and cause conflicts with other nodes.',
+		},
+		schema: [],
+	},
+	defaultOptions: [],
+	create(context) {
+		if (!context.filename.endsWith('package.json')) {
+			return {};
+		}
+
+		return {
+			ObjectExpression(node: TSESTree.ObjectExpression) {
+				if (node.parent?.type !== AST_NODE_TYPES.ExpressionStatement) {
+					return;
+				}
+
+				const overridesProp = findJsonProperty(node, 'overrides');
+				if (!overridesProp) {
+					return;
+				}
+
+				context.report({
+					node: overridesProp,
+					messageId: 'overridesForbidden',
+				});
+			},
+		};
+	},
+});