社区节点验证指南#
您希望n8n对您的节点进行验证吗?
使用n8n-node工具#
所有已验证社区节点的开发者应优先使用n8n-node工具创建和检查软件包。该工具通过以下方式帮助n8n确保质量与一致性:
- 生成标准化的包文件结构
- 在
package.json文件中添加必需的元数据和配置 - 支持根据n8n标准对代码进行规范化检查
- 允许在本地n8n实例中加载节点进行测试
软件包源码验证#
- 确认npm包仓库地址与对应的GitHub(或其他平台)仓库一致
- 核实npm与代码仓库中的包作者/维护者信息匹配
- 确保npm中的git链接有效且代码库公开可见
- 保证软件包包含完整文档(README、使用示例等)
- 确保软件包采用MIT许可证
禁止外部依赖#
- 严格确保软件包不包含任何外部依赖,以保 持轻量化和易维护性
规范文档要求#
- 提供清晰文档(GitHub上的README或相关API文档链接)
- 包含使用说明、工作流示例及必要的身份验证详情
禁止访问环境变量与文件系统#
- 代码严禁操作环境变量或尝试读写文件
- 所有必要数据均需通过节点参数传递
遵循n8n最佳实践#
- 保持清晰一致的编码风格
- 使用TypeScript并遵循n8n节点开发指南
- 实现完善的错误处理与验证机制
- 确保通过代码检查(即运行
npx @n8n/scan-community-package n8n-nodes-PACKAGE验证通过)
仅使用英语#
- 节点界面及所有文档必须仅使用英语
- 包括参数名称、描述、帮助文本、错误信息及README内容