eslint-plugin-n8n-nodes-base
Advanced tools
[](https://npmjs.org/package/eslint-plugin-n8n-nodes-base) [](https:/
ESLint plugin for linting n8n nodes.
Required: ESLint VSCode extension
npm i -D eslint-plugin-n8n-nodes-base
recommended (all rules)autofixable-safe (does not cause breaking changes)autofixable-unsafe (causes breaking changes)non-autofixable (to be manually fixed)The following example...
n8n-nodes-base plugin,recommended, and{
plugins: [ "eslint-plugin-n8n-nodes-base" ],
extends: [ "plugin:n8n-nodes-base/recommended" ],
rules: {
"n8n-nodes-base/node-param-type-options-missing-from-limit": "off"
}
}
Optionally, omit extends and enable rules individually:
{
plugins: [ "eslint-plugin-n8n-nodes-base" ],
rules: {
"n8n-nodes-base/node-param-type-options-missing-from-limit": "error"
"n8n-nodes-base/node-param-resource-without-no-data-expression": "error"
"n8n-nodes-base/node-param-resource-with-plural-option": "error"
}
}
| Name | Description | Autofixable |
|---|---|---|
| cred-class-field-display-name-miscased | displayName field in credential class must be title cased. | 🟢 |
| cred-class-field-display-name-missing-api | displayName field in credential class must be end with API. | 🟢 |
| cred-class-field-display-name-missing-oauth2 | displayName field in credential class must mention OAuth2 if applicable. | 🔵 |
| cred-class-field-documentation-url-miscased | documentationUrl field in credential class must be camel cased. | 🟢 |
| cred-class-field-documentation-url-missing | documentationUrl field in credential class must be present. | 🟢 |
| cred-class-field-name-missing-oauth2 | name field in credential class must mention OAuth2 if applicable. | 🔵 |
| cred-class-field-name-unsuffixed | name field in credential class must be suffixed with -Api. | 🔴 |
| cred-class-field-name-uppercase-first-char | First char in name in credential class must be lowercase. | 🔴 |
| cred-class-field-placeholder-url-missing-eg | placeholder for a URL in credential class must be prepended with e.g.. | 🟢 |
| cred-class-name-missing-oauth2-suffix | Credential class name must mention OAuth2 if applicable. | 🔵 |
| cred-class-name-unsuffixed | Credential class name must be suffixed with -Api. | 🔴 |
| filesystem-wrong-cred-filename | Credentials filename must match credentials class name, excluding the filename suffix. Example: TestApi.credentials.ts matches TestApi in class TestApi implements ICredentialType. | 🔵 |
| filesystem-wrong-node-dirname | Node dirname must match node filename, excluding the filename suffix. Example: Test node dirname matches Test.node.ts node filename. | 🔵 |
| filesystem-wrong-node-filename | Node filename must match name in node class description, excluding the filename suffix. Example: Test.node.ts matches Test in Test.description.name. | 🔵 |
| filesystem-wrong-resource-description-filename | Resource description file must use singular form. Example: UserDescription.ts, not UsersDescription.ts. | 🔵 |
| node-class-description-credentials-name-unsuffixed | name under credentials in node class description must be suffixed with -Api. | 🟢 |
| node-class-description-display-name-unsuffixed-trigger-node | displayName in node class description for trigger node must be suffixed with -Trigger. | 🟢 |
| node-class-description-empty-string | description in node class description must be filled out. | 🔵 |
| node-class-description-icon-not-svg | icon in node class description should be a non-SVG icon. | 🔵 |
| node-class-description-inputs-wrong-regular-node | The number of inputs in node class description for regular node should be one, or two for Merge node. | 🟢 |
| node-class-description-inputs-wrong-trigger-node | The number of inputs in node class description for trigger node should be zero. | 🟢 |
| node-class-description-missing-subtitle | subtitle in node class description must be present. | 🟢 |
| node-class-description-name-unsuffixed-trigger-node | name in node class description for trigger node must be suffixed with -Trigger. | 🟢 |
| node-class-description-outputs-wrong | The number of outputs in node class description for any node must be one, or two for If node, or four for Switch node. | 🟢 |
| node-execute-block-missing-continue-on-fail | The execute() method in a node must implement continueOnFail in a try-catch block. | 🔵 |
| node-execute-block-wrong-error-thrown | The execute() method in a node may only throw NodeApiError for failed network requests and NodeOperationError for internal errors, not the built-in Error. | 🔵 |
| node-param-array-type-assertion | Array of node parameters must be typed, not type-asserted. | 🔴 |
| node-param-collection-type-unsorted-items | Items in collection-type node parameter must be alphabetized by name if more than five. | 🟢 |
| node-param-color-type-unused | color-type must be used for color-related node parameter. | 🔴 |
| node-param-default-missing | default must be present in a node parameter. | 🟢 |
| node-param-default-wrong-for-boolean | default for boolean-type node parameter must be a boolean. | 🟢 |
| node-param-default-wrong-for-collection | default for collection-type node parameter must be an object. | 🟢 |
| node-param-default-wrong-for-fixed-collection | default for fixed-collection-type node parameter must be an object. | 🟢 |
| node-param-default-wrong-for-limit | default for a Limit node parameter must be 50 | 🟢 |
| node-param-default-wrong-for-multi-options | default for a multi-options-type node parameter must be an array. | 🟢 |
| node-param-default-wrong-for-number | default for a number-type node parameter must be a number. | 🟢 |
| node-param-default-wrong-for-options | default for an options-type node parameter must be one of the options. | 🟢 |
| node-param-default-wrong-for-simplify | default for a Simplify node parameter must be true. | 🟢 |
| node-param-default-wrong-for-string | default for a string-type node parameter must be a string. | 🟢 |
| node-param-description-boolean-without-whether | description in a boolean node parameter must start with Whether. | 🔵 |
| node-param-description-empty-string | description in node parameter or in option in options-type and multi-options-type param must be filled out or removed. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-excess-final-period | description in node parameter must end without a final period if a single-sentence description. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-excess-inner-whitespace | description in node parameter must not contain excess inner whitespace. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-identical-to-display-name | description in node parameter must not be identical to displayName. | 🔵 |
| node-param-description-line-break-html-tag | description in node parameter must not contain an HTML line break. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-lowercase-first-char | First char in description in node parameter must be uppercase. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-miscased-id | ID in description in node parameter must be fully uppercased. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-missing-final-period | description in node parameter must end with a final period if a multiple-sentence description, unless ending with </code>. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-missing-for-return-all | description for Return All node parameter must be present. | 🟢 |
| node-param-description-missing-for-simplify | description for Simplify node parameter must be present. | 🟢 |
| node-param-description-missing-from-dynamic-multi-options | description in dynamic-multi-options-type node parameter must be present. | 🟢 |
| node-param-description-missing-from-dynamic-options | description in dynamic-options-type node parameter must be present. | 🟢 |
| node-param-description-missing-from-limit | description in Limit node parameter must be present. | 🟢 |
| node-param-description-unencoded-angle-brackets | description in node parameter must encode angle brackets for them to render. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-unneeded-backticks | description in node parameter must not use unneeded backticks. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-untrimmed | description in node parameter must be trimmed. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-url-missing-protocol | description in node parameter must include protocol when containing a URL. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-weak | description in node parameter must be either useful or omitted. Applicable by extension to description in option in options-type and multi-options-type node parameter. | 🟢 |
| node-param-description-wrong-for-dynamic-multi-options | description in dynamic-multi-options-type node parameter must be Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a> | 🟢 |
| node-param-description-wrong-for-dynamic-options | description in dynamic-options-type node parameter must be Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a> | 🟢 |
| node-param-description-wrong-for-limit | description for Limit node parameter must be Max number of results to return | 🟢 |
| node-param-description-wrong-for-return-all | description for Return All node parameter must be Whether to return all results or only up to a given limit | 🟢 |
| node-param-description-wrong-for-simplify | description for Simplify node parameter must be Whether to return a simplified version of the response instead of the raw data | 🟢 |
| node-param-description-wrong-for-upsert | description for Upsert node parameter must be Create a new record, or update the current one if it already exists (upsert) | 🟢 |
| node-param-display-name-excess-inner-whitespace | displayName in node parameter or in fixed collection section must not contain excess inner whitespace. Applicable by extension to name in options-type or multi-options-type node parameter. | 🟢 |
| node-param-display-name-lowercase-first-char | First char in displayName in node parameter or in fixed collection section must be uppercase. Applicable by extension to name in options-type or multi-options-type node parameter. | 🟢 |
| node-param-display-name-miscased-id | ID in displayName in node parameter must be fully uppercased. Applicable by extension to name in options-type or multi-options-type node parameter. | 🟢 |
| node-param-display-name-miscased | displayName in node parameter or in fixed collection section must title cased. Applicable by extension to name in options-type or multi-options-type node parameter. | 🟢 |
| node-param-display-name-nonstandard-for-fixed-collection | displayName for top-level fixed collection for create operation must be Additional Fields. displayName for top-level fixed collection for update operation must be Update Fields. displayName for top-level fixed collection for get-all operation must be Options. | 🟢 |
| node-param-display-name-untrimmed | displayName in node parameter or in fixed collection section must be trimmed. Applicable by extension to name in options-type or multi-options-type node parameter. | 🟢 |
| node-param-display-name-wrong-for-dynamic-multi-options | displayName for dynamic-multi-options-type node parameter must end with Name or ID | 🔵 |
| node-param-display-name-wrong-for-dynamic-options | displayName for dynamic-options-type node parameter must end with Name or ID | 🔵 |
| node-param-display-name-wrong-for-simplify | displayName for Simplify node parameter must be Simplify | 🟢 |
| node-param-display-name-wrong-for-update-fields | displayName for Update operation node parameter must be Update Fields | 🟢 |
| node-param-fixed-collection-type-unsorted-items | Items in a fixed-collection-type node parameter must be alphabetized by displayName if more than five. | 🟢 |
| node-param-min-value-wrong-for-limit | minValue for Limit node parameter must be a positive integer. | 🟢 |
| node-param-multi-options-type-unsorted-items | Items in a multi-options-type node parameter must be alphabetized by name if more than five. | 🟢 |
| node-param-operation-without-no-data-expression | noDataExpression in an Operation node parameter must be present and enabled. | 🟢 |
| node-param-option-description-identical-to-name | description in option in options-type node parameter must not be identical to name. | 🔵 |
| node-param-option-name-containing-star | Option name in options-type node parameter must not contain *. Use [All] instead. | 🟢 |
| node-param-option-name-duplicate | Option name in options-type node parameter must not be a duplicate. | 🟢 |
| node-param-option-name-wrong-for-get-all | Option name for Get All node parameter must be Get All | 🟢 |
| node-param-option-name-wrong-for-upsert | Option name for Upsert node parameter must be Upsert. | 🟢 |
| node-param-option-value-duplicate | Option value in options-type node parameter must not be a duplicate. | 🟢 |
| node-param-options-type-unsorted-items | Items in options-type node parameter must be alphabetized by name if more than five. | 🟢 |
| node-param-required-false | required: false in node parameter must be removed becaused it is implied. | 🟢 |
| node-param-resource-with-plural-option | Option name for a Resource node parameter must be singular. | 🟢 |
| node-param-resource-without-no-data-expression | noDataExpression in a Resource node parameter must be present and enabled. | 🟢 |
| node-param-type-options-missing-from-limit | typeOptions in Limit node parameter must be present. | 🟢 |
© 2022 Iván Ovejero
Distributed under the MIT License.
FAQs
[](https://npmjs.org/package/eslint-plugin-n8n-nodes-base)
The npm package eslint-plugin-n8n-nodes-base receives a total of 12,568 weekly downloads. As such, eslint-plugin-n8n-nodes-base popularity was classified as popular.
We found that eslint-plugin-n8n-nodes-base demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.