n8n 节点代码检查工具#

n8n 的节点代码检查工具 eslint-plugin-n8n-nodes-base 能够对官方仓库和社区包中的 n8n 节点及凭据源代码进行静态分析（"代码检查"）。该检查工具可检测问题并自动修复，帮助您遵循最佳实践。 eslint-plugin-n8n-nodes-base 包含针对节点文件（*.node.ts）、资源描述文件（*Description.ts）、凭据文件（*.credentials.ts）以及社区包 package.json 的规则集合。

安装设置#

如果使用 n8n 节点入门模板：在入门项目中运行 npm install 安装所有依赖项。安装完成后即可使用代码检查工具。 如果使用 VS Code，请安装 ESLint VS Code 扩展。对于其他 IDE，请参考其 ESLint 集成文档。

请勿编辑配置文件 .eslintrc.js 包含 eslint-plugin-n8n-nodes-base 的配置，请勿修改此文件。

使用方法#

您可以在社区包或主 n8n 仓库中使用此代码检查工具。

代码检查#

在社区包中，代码检查工具会在安装依赖项后、将包发布到 npm 前自动运行。在主 n8n 仓库中，当您向拉取请求推送代码时，系统会通过 GitHub Actions 自动运行代码检查工具。

在上述两种情况下，VS Code 都会在您处理项目时在后台进行代码检查。将鼠标悬停在检测到的问题上可查看完整的检查说明和相关文档链接。

您也可以手动运行代码检查工具：

• 运行 npm run lint 进行代码检查并在控制台查看检测到的问题
• 运行 npm run lintfix 进行代码检查并自动修复问题。该工具会修复标记为可自动修复的规则违规

这两个命令都可以在您社区包（community package）的根目录下运行，或者在主代码仓库的 /packages/nodes-base/ 目录下运行。

规则例外#

除了修复规则违规外，您也可以设置规则例外，这样代码检查工具（linter）就不会标记该问题。 在 VS Code 中设置检查例外：将鼠标悬停在问题上，点击 Quick fix（macOS 系统使用 cmd+.）并选择 Disable {rule} for this line。请仅在充分理由的情况下禁用某行的规则。如果您认为检查工具误报了问题，请在检查工具代码仓库中提交报告。 若要对单个文件添加检查例外，请添加代码注释。特别要注意的是，TSLint 规则可能不会在 VS Code 中显示，可能需要通过代码注释来关闭。更多指导请参阅 TSLint 文档。

与文档交流 本页面 点赞 有帮助 点踩 无帮助 感谢您的反馈！ 提交 上一页 本地运行节点 下一页 问题排查 基于 Material for MkDocs Insiders 构建