Skip to content

社区节点验证指南#

您希望 n8n 验证您的节点吗？

如果您希望向 n8n 提交节点进行验证，请在构建节点时考虑遵循这些指南。任何启用了经过验证的社区节点的用户都可以在所有部署类型（自托管和 n8n Cloud）中从 n8n 的节点面板发现和安装经过验证的节点。

使用 n8n-node 工具#

所有经过验证的社区节点作者都应该强烈考虑使用 n8n-node 工具来创建和检查他们的包。这有助于 n8n 通过以下方式确保质量和一致性：

  • 生成预期的包文件结构
  • 向 package.json 文件添加必需的元数据和配置
  • 使您能够轻松地根据 n8n 的标准检查代码
  • 允许您在本地 n8n 实例中加载节点进行测试

包源验证#

  • 验证您的 npm 包存储库 URL 与预期的 GitHub（或其他平台）存储库匹配。
  • 确认包作者/维护者在 npm 和存储库之间匹配。
  • 确认 npm 中的 git 链接有效且存储库是公开的。
  • 确保您的包有适当的文档（README、使用示例等）。
  • 确保您的包许可证是 MIT。

无外部依赖项#

  • 确保您的包不包含任何外部依赖项，以保持轻量级和易于维护。

适当的文档#

  • 提供清晰的文档，无论是 GitHub 上的 README 还是相关 API 文档的链接。
  • 包括使用说明、示例工作流和任何必要的身份验证详细信息。

无访问环境变量或文件系统#

  • 代码不得与环境变量交互或尝试读取/写入文件。
  • 通过节点参数传递所有必要的数据。

遵循 n8n 最佳实践#

  • 保持清晰一致的编码风格。
  • 使用 TypeScript 并遵循 n8n 的节点开发指南。
  • 确保适当的错误处理和验证。
  • 确保代码检查器通过（换句话说，确保运行 npx @n8n/scan-community-package n8n-nodes-PACKAGE 通过）。

仅使用英语#

  • 节点界面和所有文档都必须仅使用English。
  • 这包括参数名称、描述、帮助文本、错误消息和 README 内容。