--- title: "@n8n/eslint-plugin-community-nodes" description: "ESLint plugin for linting n8n community node packages to ensure consistency and best practices." type: skill canonical_url: https://claudary.paisolsolutions.com/skills/readme-513 source: "Claudary" difficulty: intermediate author: "Claude Code Knowledge Pack" date: 2026-07-10T11:36:38.436Z license: CC-BY-4.0 attribution: "@n8n/eslint-plugin-community-nodes β€” Claudary (https://claudary.paisolsolutions.com/skills/readme-513)" --- # @n8n/eslint-plugin-community-nodes ESLint plugin for linting n8n community node packages to ensure consistency and best practices. ## Overview # @n8n/eslint-plugin-community-nodes ESLint plugin for linting n8n community node packages to ensure consistency and best practices. ## Install ```sh npm install --save-dev eslint @n8n/eslint-plugin-community-nodes ``` **Requires ESLint `>=9` and [flat config](https://eslint.org/docs/latest/use/configure/configuration-files) ## Usage See the [ESLint docs](https://eslint.org/docs/latest/use/configure/configuration-files) for more information about extending config files. ### Recommended config This plugin exports a `recommended` config that enforces good practices. ```js import { n8nCommunityNodesPlugin } from '@n8n/eslint-plugin-community-nodes'; export default [ // … n8nCommunityNodesPlugin.configs.recommended, { rules: { '@n8n/community-nodes/node-usable-as-tool': 'warn', }, }, ]; ``` ## Rules πŸ’Ό Configurations enabled in.\\ ⚠️ Configurations set to warn in.\\ βœ… Set in the `recommended` configuration.\\ β˜‘οΈ Set in the `recommendedWithoutN8nCloudSupport` configuration.\\ πŸ”§ Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\\ πŸ’‘ Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\\ ❌ Deprecated. | NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β  | Description | πŸ’Ό | ⚠️ | πŸ”§ | πŸ’‘ | ❌ | | :--------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :--- | :--- | :- | :- | :- | | [ai-node-package-json](docs/rules/ai-node-package-json.md) | Enforce consistency between n8n.aiNodeSdkVersion and ai-node-sdk peer dependency in community node packages | βœ… β˜‘οΈ | | | | | | [cred-class-field-icon-missing](docs/rules/cred-class-field-icon-missing.md) | Credential class must have an `icon` property defined | βœ… β˜‘οΈ | | | πŸ’‘ | | | [credential-documentation-url](docs/rules/credential-documentation-url.md) | Enforce valid credential documentationUrl format (URL or lowercase alphanumeric slug) | βœ… β˜‘οΈ | | πŸ”§ | | | | [credential-password-field](docs/rules/credential-password-field.md) | Ensure credential fields with sensitive names have typeOptions.password = true | βœ… β˜‘οΈ | | πŸ”§ | | | | [credential-test-required](docs/rules/credential-test-required.md) | Ensure credentials have a credential test | βœ… β˜‘οΈ | | | πŸ’‘ | | | [icon-validation](docs/rules/icon-validation.md) | Validate node and credential icon files exist, are SVG format, and light/dark icons are different | βœ… β˜‘οΈ | | | πŸ’‘ | | | [missing-paired-item](docs/rules/missing-paired-item.md) | Require pairedItem on INodeExecutionData objects in execute() methods to preserve item linking. | βœ… β˜‘οΈ | | | | | | [no-credential-reuse](docs/rules/no-credential-reuse.md) | Prevent credential re-use security issues by ensuring nodes only reference credentials from the same package | βœ… β˜‘οΈ | | | πŸ’‘ | | | [no-deprecated-workflow-functions](docs/rules/no-deprecated-workflow-functions.md) | Disallow usage of deprecated functions and types from n8n-workflow package | βœ… β˜‘οΈ | | | πŸ’‘ | | | [no-forbidden-lifecycle-scripts](docs/rules/no-forbidden-lifecycle-scripts.md) | Ban lifecycle scripts (prepare, preinstall, postinstall, etc.) in community node packages | βœ… β˜‘οΈ | | | | | | [no-http-request-with-manual-auth](docs/rules/no-http-request-with-manual-auth.md) | Disallow this.helpers.httpRequest() in functions that call this.getCredentials(). Use this.helpers.httpRequestWithAuthentication() instead. | βœ… β˜‘οΈ | | | | | | [no-overrides-field](docs/rules/no-overrides-field.md) | Ban the "overrides" field in community node package.json | βœ… β˜‘οΈ | | | | | | [no-restricted-globals](docs/rules/no-restricted-globals.md) | Disallow usage of restricted global variables in community nodes. | βœ… | | | | | | [no-restricted-imports](docs/rules/no-restricted-imports.md) | Disallow usage of restricted imports in community nodes. | βœ… | | | | | | [node-class-description-icon-missing](docs/rules/node-class-description-icon-missing.md) | Node class description must have an `icon` property defined. Deprecated: use `require-node-description-fields` instead. | | | | πŸ’‘ | ❌ | | [node-connection-type-literal](docs/rules/node-connection-type-literal.md) | Disallow string literals in node description `inputs`/`outputs` β€” use `NodeConnectionTypes` enum instead | βœ… β˜‘οΈ | | πŸ”§ | | | | [node-usable-as-tool](docs/rules/node-usable-as-tool.md) | Ensure node classes have usableAsTool property | βœ… β˜‘οΈ | | πŸ”§ | | | | [options-sorted-alphabetically](docs/rules/options-sorted-alphabetically.md) | Enforce alphabetical ordering of options arrays in n8n node properties | | βœ… β˜‘οΈ | | | | | [package-name-convention](docs/rules/package-name-convention.md) | Enforce correct package naming convention for n8n community nodes | βœ… β˜‘οΈ | | | πŸ’‘ | | | [require-community-node-keyword](docs/rules/require-community-node-keyword.md) | Require the "n8n-community-node-package" keyword in community node package.json | | βœ… β˜‘οΈ | πŸ”§ | | | | [require-continue-on-fail](docs/rules/require-continue-on-fail.md) | Require continueOnFail() handling in execute() methods of node classes | βœ… β˜‘οΈ | | | | | | [require-node-api-error](docs/rules/require-node-api-error.md) | Require NodeApiError or NodeOperationError for error wrapping in catch blocks. Raw errors lose HTTP context in the n8n UI. | βœ… β˜‘οΈ | | | | | | [require-node-description-fields](docs/rules/require-node-description-fields.md) | Node class description must define all required fields: icon, subtitle | βœ… β˜‘οΈ | | | | | | [resource-operation-pattern](docs/rules/resource-operation-pattern.md) | Enforce proper resource/operation pattern for better UX in n8n nodes | | βœ… β˜‘οΈ | | | | | [webhook-lifecycle-complete](docs/rules/webhook-lifecycle-complete.md) | Require webhook trigger nodes to implement the complete webhookMethods lifecycle (checkExists, create, delete) | βœ… β˜‘οΈ | | | | | --- Source: [Claudary](https://claudary.paisolsolutions.com/skills/readme-513) Β· https://claudary.paisolsolutions.com