构建社区节点#

可能会有变化

本文档中描述的标准适用于社区节点存储库的第一个版本。这些标准在未来的版本中可能会发生变化。

社区节点是托管在 npm 注册表中的 npm 包。

在构建要提交到社区节点存储库的节点时，请使用以下资源确保您的节点设置正确：

n8n 建议使用 n8n-node CLI 工具来构建和测试您的节点。特别是，如果您计划提交节点进行验证，这一点很重要。这确保您的节点具有正确的结构并遵循社区节点要求。它还简化了代码检查和测试。
查看 n8n 自己的节点以获取您可以在节点中使用的模式示例。
参考构建自己的节点的文档。
确保您的节点遵循社区节点的标准。

标准#

使用 n8n-node 工具进行开发可确保您的节点符合以下标准，这些标准是在 n8n 社区节点存储库中提供您的节点所必需的：

确保包名称以 n8n-nodes- 或 @<scope>/n8n-nodes- 开头。例如，n8n-nodes-weather 或 @weatherPlugins/n8n-nodes-weather。
在您的包关键字中包含 n8n-community-node-package。
确保您将节点和凭据添加到 package.json 文件中的 n8n 属性内。
使用代码检查器（npm run lint）检查您的节点并在本地测试（npm run dev）以确保它正常工作。
将包提交到 npm 注册表。有关更多信息，请参考 npm 关于向注册表贡献包的文档。

n8n 审查经过验证的社区节点。用户可以从 n8n 的节点面板中发现和安装经过验证的社区节点。这些节点需要遵循某些技术和用户体验标准及约束。

在向 n8n 提交节点进行审查之前，您必须：

从 n8n-node 工具生成的脚手架开始。虽然这不是严格要求的，但 n8n 强烈建议对您计划提交验证的任何社区节点使用 n8n-node CLI 工具。使用该工具可确保您的节点遵循预期的约定并符合社区节点要求。
确保您的节点遵循经过验证的社区节点的技术指南并且所有自动化检查都通过。具体来说，经过验证的社区节点不允许使用任何运行时依赖项。
确保您的节点遵循用户体验指南。
确保节点在 npm 包或相关公共存储库中以 README 的形式具有适当的文档。
将您的节点提交到 npm，因为 n8n 将从那里获取它进行最终审查。

如果您的节点满足上述所有要求，请点击此处提交您的节点进行验证。请注意，n8n 保留拒绝与 n8n 任何付费功能（特别是企业功能）竞争的节点的权利。