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

package/dist/rules/require-continue-on-fail.js

@@ -1,76 +0,0 @@
-import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import { isNodeTypeClass } from '../utils/index.js';
-import { createRule } from '../utils/rule-creator.js';
-/** Keys that are not child AST nodes (back-references, metadata). */
-const NON_CHILD_KEYS = new Set(['parent', 'loc', 'range', 'start', 'end', 'tokens', 'comments']);
-/**
- * Recursively checks whether any descendant of the given AST node is a
- * `this.continueOnFail()` call expression.
- */
-function containsContinueOnFailCall(node) {
-    if (node.type === AST_NODE_TYPES.CallExpression &&
-        node.callee.type === AST_NODE_TYPES.MemberExpression &&
-        node.callee.object.type === AST_NODE_TYPES.ThisExpression &&
-        node.callee.property.type === AST_NODE_TYPES.Identifier &&
-        node.callee.property.name === 'continueOnFail') {
-        return true;
-    }
-    for (const key of Object.keys(node)) {
-        if (NON_CHILD_KEYS.has(key))
-            continue;
-        const value = node[key];
-        if (Array.isArray(value)) {
-            for (const child of value) {
-                if (child && typeof child === 'object' && 'type' in child) {
-                    if (containsContinueOnFailCall(child)) {
-                        return true;
-                    }
-                }
-            }
-        }
-        else if (value && typeof value === 'object' && 'type' in value) {
-            if (containsContinueOnFailCall(value)) {
-                return true;
-            }
-        }
-    }
-    return false;
-}
-export const RequireContinueOnFailRule = createRule({
-    name: 'require-continue-on-fail',
-    meta: {
-        type: 'problem',
-        docs: {
-            description: 'Require continueOnFail() handling in execute() methods of node classes',
-        },
-        messages: {
-            missingContinueOnFail: 'execute() method must handle this.continueOnFail() for proper error handling. ' +
-                'Wrap item processing in a try/catch and check this.continueOnFail() in the catch block.',
-        },
-        schema: [],
-    },
-    defaultOptions: [],
-    create(context) {
-        return {
-            ClassDeclaration(node) {
-                if (!isNodeTypeClass(node)) {
-                    return;
-                }
-                for (const member of node.body.body) {
-                    if (member.type !== AST_NODE_TYPES.MethodDefinition ||
-                        member.key.type !== AST_NODE_TYPES.Identifier ||
-                        member.key.name !== 'execute') {
-                        continue;
-                    }
-                    if (member.value.body && !containsContinueOnFailCall(member.value.body)) {
-                        context.report({
-                            node: member.key,
-                            messageId: 'missingContinueOnFail',
-                        });
-                    }
-                }
-            },
-        };
-    },
-});
-//# sourceMappingURL=require-continue-on-fail.js.map

package/dist/rules/require-continue-on-fail.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"require-continue-on-fail.js","sourceRoot":"","sources":["../../src/rules/require-continue-on-fail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAiB,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAEtD,qEAAqE;AACrE,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;AAEjG;;;GAGG;AACH,SAAS,0BAA0B,CAAC,IAAmB;IACtD,IACC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,cAAc;QAC3C,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;QACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,cAAc;QACzD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;QACvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,gBAAgB,EAC7C,CAAC;QACF,OAAO,IAAI,CAAC;IACb,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,IAAI,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,SAAS;QAEtC,MAAM,KAAK,GAAI,IAA2C,CAAC,GAAG,CAAC,CAAC;QAEhE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;gBAC3B,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;oBAC3D,IAAI,0BAA0B,CAAC,KAAsB,CAAC,EAAE,CAAC;wBACxD,OAAO,IAAI,CAAC;oBACb,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;aAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;YAClE,IAAI,0BAA0B,CAAC,KAAsB,CAAC,EAAE,CAAC;gBACxD,OAAO,IAAI,CAAC;YACb,CAAC;QACF,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC;IACnD,IAAI,EAAE,0BAA0B;IAChC,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,wEAAwE;SACrF;QACD,QAAQ,EAAE;YACT,qBAAqB,EACpB,gFAAgF;gBAChF,yFAAyF;SAC1F;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,EAAE,CAAC;oBAC5B,OAAO;gBACR,CAAC;gBAED,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACrC,IACC,MAAM,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;wBAC/C,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU;wBAC7C,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,EAC5B,CAAC;wBACF,SAAS;oBACV,CAAC;oBAED,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;wBACzE,OAAO,CAAC,MAAM,CAAC;4BACd,IAAI,EAAE,MAAM,CAAC,GAAG;4BAChB,SAAS,EAAE,uBAAuB;yBAClC,CAAC,CAAC;oBACJ,CAAC;gBACF,CAAC;YACF,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}

package/dist/rules/require-mit-license.d.ts

@@ -1,2 +0,0 @@
-export declare const RequireMitLicenseRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingLicense" | "wrongLicense", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-//# sourceMappingURL=require-mit-license.d.ts.map

package/dist/rules/require-mit-license.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"require-mit-license.d.ts","sourceRoot":"","sources":["../../src/rules/require-mit-license.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,qBAAqB,oKAyDhC,CAAC"}

package/dist/rules/require-mit-license.js

@@ -1,57 +0,0 @@
-import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import { createRule, findJsonProperty, getStringLiteralValue } from '../utils/index.js';
-const REQUIRED_LICENSE = 'MIT';
-export const RequireMitLicenseRule = createRule({
-    name: 'require-mit-license',
-    meta: {
-        type: 'problem',
-        docs: {
-            description: 'Require the "license" field in community node package.json to be "MIT"',
-        },
-        fixable: 'code',
-        messages: {
-            missingLicense: `The package.json must have a "license" field set to "${REQUIRED_LICENSE}".`,
-            wrongLicense: `The "license" field must be "${REQUIRED_LICENSE}".`,
-        },
-        schema: [],
-    },
-    defaultOptions: [],
-    create(context) {
-        if (!context.filename.endsWith('package.json')) {
-            return {};
-        }
-        return {
-            ObjectExpression(node) {
-                if (node.parent?.type !== AST_NODE_TYPES.ExpressionStatement) {
-                    return;
-                }
-                const licenseProp = findJsonProperty(node, 'license');
-                if (!licenseProp) {
-                    context.report({
-                        node,
-                        messageId: 'missingLicense',
-                        fix(fixer) {
-                            const lastProp = node.properties[node.properties.length - 1];
-                            if (!lastProp) {
-                                return fixer.replaceText(node, `{ "license": "${REQUIRED_LICENSE}" }`);
-                            }
-                            return fixer.insertTextAfter(lastProp, `, "license": "${REQUIRED_LICENSE}"`);
-                        },
-                    });
-                    return;
-                }
-                if (getStringLiteralValue(licenseProp.value) === REQUIRED_LICENSE) {
-                    return;
-                }
-                context.report({
-                    node: licenseProp.value,
-                    messageId: 'wrongLicense',
-                    fix(fixer) {
-                        return fixer.replaceText(licenseProp.value, `"${REQUIRED_LICENSE}"`);
-                    },
-                });
-            },
-        };
-    },
-});
-//# sourceMappingURL=require-mit-license.js.map

package/dist/rules/require-mit-license.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"require-mit-license.js","sourceRoot":"","sources":["../../src/rules/require-mit-license.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAExF,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAE/B,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAAC;IAC/C,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,wEAAwE;SACrF;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACT,cAAc,EAAE,wDAAwD,gBAAgB,IAAI;YAC5F,YAAY,EAAE,gCAAgC,gBAAgB,IAAI;SAClE;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAChD,OAAO,EAAE,CAAC;QACX,CAAC;QAED,OAAO;YACN,gBAAgB,CAAC,IAA+B;gBAC/C,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;oBAC9D,OAAO;gBACR,CAAC;gBAED,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAEtD,IAAI,CAAC,WAAW,EAAE,CAAC;oBAClB,OAAO,CAAC,MAAM,CAAC;wBACd,IAAI;wBACJ,SAAS,EAAE,gBAAgB;wBAC3B,GAAG,CAAC,KAAK;4BACR,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;4BAC7D,IAAI,CAAC,QAAQ,EAAE,CAAC;gCACf,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,gBAAgB,KAAK,CAAC,CAAC;4BACxE,CAAC;4BACD,OAAO,KAAK,CAAC,eAAe,CAAC,QAAQ,EAAE,iBAAiB,gBAAgB,GAAG,CAAC,CAAC;wBAC9E,CAAC;qBACD,CAAC,CAAC;oBACH,OAAO;gBACR,CAAC;gBAED,IAAI,qBAAqB,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,gBAAgB,EAAE,CAAC;oBACnE,OAAO;gBACR,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACd,IAAI,EAAE,WAAW,CAAC,KAAK;oBACvB,SAAS,EAAE,cAAc;oBACzB,GAAG,CAAC,KAAK;wBACR,OAAO,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,gBAAgB,GAAG,CAAC,CAAC;oBACtE,CAAC;iBACD,CAAC,CAAC;YACJ,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}

package/dist/rules/require-param-default.d.ts

@@ -1,15 +0,0 @@
-/**
- * Requires every node parameter to declare a `default` property.
- *
- * A parameter is detected structurally: an object literal inside a node's
- * `description` with `displayName`, `name`, and `type` all set to string
- * literals — the shape every `INodeProperties` entry has. This avoids
- * hardcoding the `NodePropertyTypes` union (which would silently go stale as
- * new types are added) and naturally excludes `options`-array entries, which
- * carry `name`/`value` but no `displayName`/`type`.
- *
- * Without a `default`, n8n cannot reliably initialise the parameter's value,
- * which leads to inconsistent runtime behaviour in the editor and on execution.
- */
-export declare const RequireParamDefaultRule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"missingDefault", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-//# sourceMappingURL=require-param-default.d.ts.map

package/dist/rules/require-param-default.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"require-param-default.d.ts","sourceRoot":"","sources":["../../src/rules/require-param-default.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AA0BH,eAAO,MAAM,uBAAuB,mJAkDlC,CAAC"}

package/dist/rules/require-param-default.js

@@ -1,75 +0,0 @@
-/**
- * Requires every node parameter to declare a `default` property.
- *
- * A parameter is detected structurally: an object literal inside a node's
- * `description` with `displayName`, `name`, and `type` all set to string
- * literals — the shape every `INodeProperties` entry has. This avoids
- * hardcoding the `NodePropertyTypes` union (which would silently go stale as
- * new types are added) and naturally excludes `options`-array entries, which
- * carry `name`/`value` but no `displayName`/`type`.
- *
- * Without a `default`, n8n cannot reliably initialise the parameter's value,
- * which leads to inconsistent runtime behaviour in the editor and on execution.
- */
-import { simpleTraverse } from '@typescript-eslint/typescript-estree';
-import { AST_NODE_TYPES } from '@typescript-eslint/utils';
-import { createRule, findClassProperty, findObjectProperty, getStringLiteralValue, isFileType, isNodeTypeClass, } from '../utils/index.js';
-/** Property keys an `INodeProperties` parameter always carries as string literals. */
-const REQUIRED_PARAM_KEYS = ['displayName', 'name', 'type'];
-/** Returns true when the object literal has the shape of a node parameter. */
-function isNodeParameter(node) {
-    return REQUIRED_PARAM_KEYS.every((key) => {
-        const property = findObjectProperty(node, key);
-        return property !== null && getStringLiteralValue(property.value) !== null;
-    });
-}
-export const RequireParamDefaultRule = createRule({
-    name: 'require-param-default',
-    meta: {
-        type: 'problem',
-        docs: {
-            description: 'Require every node parameter to declare a default value.',
-        },
-        messages: {
-            missingDefault: "Node parameter '{{ name }}' is missing a `default` value. Add a `default` property so the parameter initialises consistently.",
-        },
-        schema: [],
-    },
-    defaultOptions: [],
-    create(context) {
-        if (!isFileType(context.filename, '.node.ts')) {
-            return {};
-        }
-        const reportIfMissingDefault = (node) => {
-            if (!isNodeParameter(node) || findObjectProperty(node, 'default') !== null) {
-                return;
-            }
-            const nameProperty = findObjectProperty(node, 'name');
-            context.report({
-                node,
-                messageId: 'missingDefault',
-                data: { name: getStringLiteralValue(nameProperty?.value ?? null) ?? '' },
-            });
-        };
-        return {
-            // Scope to an INodeType class's `description`, then walk only that
-            // subtree, so helper classes and object literals elsewhere in the file
-            // (e.g. in method bodies) that share the parameter shape are ignored.
-            ClassDeclaration(node) {
-                if (!isNodeTypeClass(node))
-                    return;
-                const description = findClassProperty(node, 'description');
-                if (description?.value?.type !== AST_NODE_TYPES.ObjectExpression)
-                    return;
-                simpleTraverse(description.value, {
-                    enter(child) {
-                        if (child.type === AST_NODE_TYPES.ObjectExpression) {
-                            reportIfMissingDefault(child);
-                        }
-                    },
-                });
-            },
-        };
-    },
-});
-//# sourceMappingURL=require-param-default.js.map

package/dist/rules/require-param-default.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"require-param-default.js","sourceRoot":"","sources":["../../src/rules/require-param-default.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAEtE,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACV,eAAe,GACf,MAAM,mBAAmB,CAAC;AAE3B,sFAAsF;AACtF,MAAM,mBAAmB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAErE,8EAA8E;AAC9E,SAAS,eAAe,CAAC,IAA+B;IACvD,OAAO,mBAAmB,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;QACxC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/C,OAAO,QAAQ,KAAK,IAAI,IAAI,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;IAC5E,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAAC;IACjD,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE;QACL,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACL,WAAW,EAAE,0DAA0D;SACvE;QACD,QAAQ,EAAE;YACT,cAAc,EACb,+HAA+H;SAChI;QACD,MAAM,EAAE,EAAE;KACV;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACb,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACX,CAAC;QAED,MAAM,sBAAsB,GAAG,CAAC,IAA+B,EAAQ,EAAE;YACxE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC5E,OAAO;YACR,CAAC;YACD,MAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACtD,OAAO,CAAC,MAAM,CAAC;gBACd,IAAI;gBACJ,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,EAAE,IAAI,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE;aACxE,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,OAAO;YACN,mEAAmE;YACnE,uEAAuE;YACvE,sEAAsE;YACtE,gBAAgB,CAAC,IAAI;gBACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;oBAAE,OAAO;gBACnC,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;gBAC3D,IAAI,WAAW,EAAE,KAAK,EAAE,IAAI,KAAK,cAAc,CAAC,gBAAgB;oBAAE,OAAO;gBAEzE,cAAc,CAAC,WAAW,CAAC,KAAK,EAAE;oBACjC,KAAK,CAAC,KAAK;wBACV,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;4BACpD,sBAAsB,CAAC,KAAK,CAAC,CAAC;wBAC/B,CAAC;oBACF,CAAC;iBACD,CAAC,CAAC;YACJ,CAAC;SACD,CAAC;IACH,CAAC;CACD,CAAC,CAAC"}

package/docs/rules/cred-class-name-field-conventions.md

@@ -1,38 +0,0 @@
-# Credential `name` field must end with `Api` and start with a lowercase letter (`@n8n/community-nodes/cred-class-name-field-conventions`)
-
-💼 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 of a credential class (those implementing `ICredentialType` in `*.credentials.ts` files) is the internal identifier referenced by nodes and stored in the credential registry. n8n convention requires this identifier to:
-
-- End with `Api` (e.g. `githubApi`), so credentials are easily recognisable across the codebase.
-- Start with a lowercase letter (camelCase), since it is an identifier value rather than a class name.
-
-Both checks are automatically fixable.
-
-## Examples
-
-### ❌ Incorrect
-
-```typescript
-export class GithubApi implements ICredentialType {
-  name = 'Github';
-  displayName = 'GitHub API';
-  properties: INodeProperties[] = [];
-}
-```
-
-### ✅ Correct
-
-```typescript
-export class GithubApi implements ICredentialType {
-  name = 'githubApi';
-  displayName = 'GitHub API';
-  properties: INodeProperties[] = [];
-}
-```

package/docs/rules/cred-class-name-suffix.md

@@ -1,46 +0,0 @@
-# Credential class names must be suffixed with `Api` (`@n8n/community-nodes/cred-class-name-suffix`)
-
-💼 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
-
-Credential classes (those implementing `ICredentialType` in `*.credentials.ts` files) must have a class name ending in `Api`. This is the n8n convention so credentials are easily recognisable in code, in import statements, and across the credential registry.
-
-For OAuth2 credentials extending the OAuth2 base, see the sibling rule `cred-class-oauth2-naming` which enforces the more specific `OAuth2Api` suffix.
-
-## Opt-out
-
-For legitimate exceptions (for example credentials representing custom auth headers where the `Api` suffix would be misleading), disable the rule for the specific class with a standard ESLint comment:
-
-```typescript
-// eslint-disable-next-line @n8n/community-nodes/cred-class-name-suffix
-export class CustomAuthHeader implements ICredentialType {
-  // ...
-}
-```
-
-## Examples
-
-### ❌ Incorrect
-
-```typescript
-export class MyService implements ICredentialType {
-  name = 'myServiceApi';
-  displayName = 'My Service API';
-  properties: INodeProperties[] = [];
-}
-```
-
-### ✅ Correct
-
-```typescript
-export class MyServiceApi implements ICredentialType {
-  name = 'myServiceApi';
-  displayName = 'My Service API';
-  properties: INodeProperties[] = [];
-}
-```

package/docs/rules/cred-filename-against-convention.md

@@ -1,42 +0,0 @@
-# Credential filename must match the credential class name (`@n8n/community-nodes/cred-filename-against-convention`)
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
-
-<!-- end auto-generated rule header -->
-
-## Rule Details
-
-This rule enforces that the basename of a `*.credentials.ts` file (without the
-`.credentials.ts` extension) matches the name of the credential class it
-contains. The class name is the source of truth.
-
-Keeping filenames in sync with class names makes credentials predictable to
-locate and matches the convention used throughout n8n's built-in credentials.
-
-## Examples
-
-### Incorrect
-
-```typescript
-// File: GithubApi.credentials.ts
-import type { ICredentialType, INodeProperties } from 'n8n-workflow';
-
-export class GitlabApi implements ICredentialType {
-	name = 'gitlabApi';
-	displayName = 'GitLab API';
-	properties: INodeProperties[] = [];
-}
-```
-
-### Correct
-
-```typescript
-// File: GithubApi.credentials.ts
-import type { ICredentialType, INodeProperties } from 'n8n-workflow';
-
-export class GithubApi implements ICredentialType {
-	name = 'githubApi';
-	displayName = 'GitHub API';
-	properties: INodeProperties[] = [];
-}
-```

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

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

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

@@ -1,41 +0,0 @@
-# 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/node-filename-against-convention.md

@@ -1,50 +0,0 @@
-# Node filename must match the node `description.name` (`@n8n/community-nodes/node-filename-against-convention`)
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
-
-<!-- end auto-generated rule header -->
-
-## Rule Details
-
-Every `*.node.ts` file must be named after its node's `description.name`, with the
-first character upper-cased. The source of truth is `description.name` — **not**
-the class name. Keeping the filename in sync with the registered node name makes
-nodes predictable to locate and matches the convention n8n tooling expects.
-
-A trailing version suffix (`V2`, `V3`, …) is allowed, so versioned implementations
-such as `GithubV2.node.ts` are accepted for a node whose `description.name` is
-`github`.
-
-The comparison is case-sensitive: a node named `github` must live in
-`Github.node.ts`, not `github.node.ts` or `GitHub.node.ts`.
-
-This rule is not auto-fixable because ESLint cannot rename files. Rename the file
-to the reported name.
-
-## Examples
-
-### ❌ Incorrect
-
-```typescript
-// File: Gitlab.node.ts
-export class Github implements INodeType {
-  description: INodeTypeDescription = {
-    displayName: 'GitHub',
-    name: 'github', // expected file to be named "Github.node.ts"
-    // ...
-  };
-}
-```
-
-### ✅ Correct
-
-```typescript
-// File: Github.node.ts (or GithubV2.node.ts)
-export class Github implements INodeType {
-  description: INodeTypeDescription = {
-    displayName: 'GitHub',
-    name: 'github',
-    // ...
-  };
-}
-```

package/docs/rules/node-operation-error-itemindex.md

@@ -1,81 +0,0 @@
-# Require { itemIndex } in NodeOperationError / NodeApiError options inside item loops (`@n8n/community-nodes/node-operation-error-itemindex`)
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ☑️ `recommendedWithoutN8nCloudSupport`.
-
-<!-- end auto-generated rule header -->
-
-## Rule Details
-
-When throwing `NodeOperationError` or `NodeApiError` inside the item-processing loop of an `execute()` method, the options object (third argument) must contain an `itemIndex` property. Without it, n8n cannot associate the error with the specific item that caused it, which breaks per-item error reporting and `continueOnFail` behaviour.
-
-The rule only fires inside **item loops** — `for` or `for...of` statements that iterate over the result of `this.getInputData()`. Errors thrown outside such loops (e.g. in webhook handlers, trigger setup, or credential testing helpers) are not flagged.
-
-## Examples
-
-### ❌ Incorrect
-
-```typescript
-export class MyNode implements INodeType {
-  description: INodeTypeDescription = { /* ... */ };
-
-  async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
-    const items = this.getInputData();
-    const returnData: INodeExecutionData[] = [];
-
-    for (let i = 0; i < items.length; i++) {
-      try {
-        // ...
-      } catch (error) {
-        // Missing { itemIndex } — n8n cannot map this error back to item i
-        throw new NodeOperationError(this.getNode(), error);
-      }
-    }
-
-    return [returnData];
-  }
-}
-```
-
-### ✅ Correct
-
-```typescript
-export class MyNode implements INodeType {
-  description: INodeTypeDescription = { /* ... */ };
-
-  async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
-    const items = this.getInputData();
-    const returnData: INodeExecutionData[] = [];
-
-    for (let i = 0; i < items.length; i++) {
-      try {
-        // ...
-      } catch (error) {
-        throw new NodeOperationError(this.getNode(), error, { itemIndex: i });
-      }
-    }
-
-    return [returnData];
-  }
-}
-```
-
-Using `for...of` with a named loop variable:
-
-```typescript
-async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
-  const items = this.getInputData();
-  const returnData: INodeExecutionData[] = [];
-  let itemIndex = 0;
-
-  for (const item of items) {
-    try {
-      // ...
-    } catch (error) {
-      throw new NodeApiError(this.getNode(), error, { itemIndex });
-    }
-    itemIndex++;
-  }
-
-  return [returnData];
-}
-```