eslint-plugin-n8n-nodes-base weekly downloads statistics

eslint-plugin-n8n-nodes-base

ESLint plugin for linting n8n nodes.

Usage

Install this plugin:

pnpm i -D eslint-plugin-n8n-nodes-base

Create an ESLint configuration file and decide how to set up the plugin.

Specify only plugin

If you specify only the plugin, all rules in the plugin are disabled by default and must be individually enabled:

{
  plugins: [ "eslint-plugin-n8n-nodes-base" ],
  rules: {
    "n8n-nodes-base/node-param-array-type-assertion": "warn",
    "n8n-nodes-base/node-param-default-wrong-for-collection": "error"
  }
}

Specify plugin and config

If you specify both the plugin and a config, all config rules are enabled by default and must be individually disabled:

{
  plugins: [ "eslint-plugin-n8n-nodes-base" ],
  extends: [ "plugin:n8n-nodes-base/nodes" ],
  rules: {
    "n8n-nodes-base/node-param-array-type-assertion": "off",
    "n8n-nodes-base/node-param-default-wrong-for-collection": "off"
  }
}

Config	Content
nodes	Ruleset for n8n nodes
credentials	Ruleset for n8n credentials
community	Ruleset for package.json in n8n community package

User-defined defaults

In the community ruleset, the five *-still-default rules allow you to define your own default values:

{
  plugins: [ "eslint-plugin-n8n-nodes-base" ],
  extends: [ "plugin:n8n-nodes-base/nodes" ],
  rules: {
    "n8n-nodes-base/community-package-json-author-name-still-default": [
      "error",
      { authorName: "Neil Armstrong" }, // user-defined default
    ],
  }
}

Ruleset

<!-- RULES_TABLE -->

Name	Description	Autofixable
community-package-json-author-email-still-default	The author.email value in the package.json of a community package must be different from the default value '' (empty string) or a user-defined default.	No
community-package-json-author-missing	The author key must be present in the package.json of a community package.	No
community-package-json-author-name-missing	The author.name key must be present in the package.json of a community package.	No
community-package-json-author-name-still-default	The author.name value in the package.json of a community package must be different from the default value '' (empty string) or a user-defined default.	No
community-package-json-description-missing	The description key must be present in the package.json of a community package.	No
community-package-json-description-still-default	The description value in the package.json of a community package must be different from the default value '' (empty string) or a user-defined default.	No
community-package-json-keywords-missing	The keywords key must be present in the package.json of a community package.	No
community-package-json-keywords-without-official-tag	The keywords value in the package.json of a community package must be an array containing the value 'n8n-community-node-package'.	No
community-package-json-license-missing	The description key must be present in the package.json of a community package.	No
community-package-json-license-not-default	The license key in the package.json of a community package must be the default value MIT.	No
community-package-json-n8n-api-version-missing	The n8n.n8nNodesApiVersion key must be present in the package.json of a community package.	No
community-package-json-n8n-api-version-not-number	The n8n.n8nNodesApiVersion value in the package.json of a community package must be a number.	No
community-package-json-n8n-missing	The n8n key must be present in the package.json of a community package.	No
community-package-json-n8n-nodes-empty	The n8n.nodes value in the package.json of a community package must contain at least one filepath.	No
community-package-json-n8n-nodes-missing	The n8n.nodes key must be present in the package.json of a community package.	No
community-package-json-name-missing	The name key must be present in the package.json of a community package.	No
community-package-json-name-still-default	The name key in the package.json of a community package must be different from the…