构建社区节点

/// 注意 | 可能变更 本文档描述的标准适用于社区节点仓库的首个版本。这些标准在未来的版本中可能会有所变更。 ///

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

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

• 查看 starter node 和 n8n 自有节点 获取示例。
• 参考关于构建自定义节点的文档。
• 确保您的节点遵循社区节点的标准。

标准

要使您的节点能够被纳入 n8n 社区节点仓库，您必须：

• 确保包名以 n8n-nodes- 或 @<scope>/n8n-nodes- 开头。例如：n8n-nodes-weather 或 @weatherPlugins/n8n-nodes-weather。
• 在包的 keywords 中包含 n8n-community-node-package。
• 确保将您的节点和凭据添加到 package.json 文件中的 n8n 属性下。参考 starter node 中的 package.json 作为示例。
• 使用 linter 检查您的节点，并在本地测试以确保其正常工作。
• 将包提交到 npm 注册表。更多信息请参考 npm 关于向注册表贡献包 的文档。

提交您的节点供 n8n 验证

n8n 会对已验证的社区节点进行审核。用户可以从 n8n 的节点面板中发现并安装这些已验证的社区节点。这些节点需要遵守特定的技术标准和用户体验规范。

在提交您的节点供 n8n 审核之前，您必须：

• 确保您的节点遵循已验证社区节点的技术指南，并且所有自动化检查都已通过。特别需要注意的是，已验证的社区节点不允许使用任何运行时依赖。
• 确保您的节点符合用户体验指南。
• 确保节点在 npm 包或相关公共仓库中以 README 文件形式提供了适当的文档。
• 将您的节点提交到 npm，因为 n8n 会从那里获取它进行最终审核。

如果您的节点满足上述所有要求，请点击此处提交您的节点进行验证。