Skip to content

社区节点验证指南(Community node verification guidelines)#

你想让 n8n 验证你的节点吗？

如果你希望将节点提交给 n8n 进行验证，请在构建节点时考虑遵循以下指南。任何启用了已验证社区节点的用户都可以在 n8n 的节点面板中发现并安装经过验证的节点，适用于所有部署类型（自托管和 n8n 云）。

使用 n8n 节点工具(Use the n8n-node tool)#

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

🌐 All verified community node authors should strongly consider using the n8n-node tool to create and check their package. This helps n8n ensure quality and consistency by:

  • 生成预期的软件包文件结构。
  • 向 package.json 文件添加所需的元数据和配置
  • 方便你根据 n8n 标准检查代码。
  • 允许你在本地 n8n 实例中加载节点进行测试

软件包来源验证(Package source verification)#

  • 验证你的 npm 包仓库 URL 是否与预期的 GitHub（或其他平台）仓库匹配。
  • 确认 npm 和仓库中的包作者/维护者一致。
  • 确认 npm 中的 Git 链接有效，并且该仓库是公开的。
  • 确保你的软件包拥有完善的文档（README、使用示例等）。
  • 确保你的软件包许可证为 MIT 许可证。

无外部依赖(No external dependencies)#

  • 确保你的软件包不包含任何外部依赖，以保持其轻量且易于维护。

完整文档(Proper documentation)#

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

无法访问环境变量或文件系统(No access to environment variables or file system)#

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

遵循 n8n 最佳实践(Follow n8n best practices)#

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

仅使用英语(Use English language only)#

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