Back to N8n

Enforce correct package naming convention for n8n community nodes (`@n8n/community-nodes/package-name-convention`)

packages/@n8n/eslint-plugin-community-nodes/docs/rules/package-name-convention.md

1.37.21.1 KB
Original Source

Enforce correct package naming convention for n8n community nodes (@n8n/community-nodes/package-name-convention)

šŸ’¼ This rule is enabled in the following configs: āœ… recommended, ā˜‘ļø recommendedWithoutN8nCloudSupport.

šŸ’” This rule is manually fixable by editor suggestions.

<!-- end auto-generated rule header -->

Rule Details

Validates that your package name follows the correct n8n community node naming convention. Package names must start with n8n-nodes- and can optionally be scoped.

Examples

āŒ Incorrect

json
{
  "name": "my-service-integration"
}
json
{
  "name": "nodes-my-service"
}
json
{
  "name": "@company/my-service"
}

āœ… Correct

json
{
  "name": "n8n-nodes-my-service"
}
json
{
  "name": "@company/n8n-nodes-my-service"
}

Best Practices

  • Use descriptive service names: n8n-nodes-github rather than n8n-nodes-api
  • For company packages, use your organization scope: @mycompany/n8n-nodes-internal-tool