Files
n8n-nodes-gwezz-changdunovel/node_modules/@n8n/eslint-plugin-community-nodes/docs/rules/package-name-convention.md
2025-10-26 23:10:15 +08:00

1.1 KiB

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.

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

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

Correct

{
  "name": "n8n-nodes-my-service"
}
{
  "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