跳到主要内容

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 进行检查并自动修复问题。该工具会修复标记为可自动修复的规则违规

这两个命令可在社区包的根目录或主仓库的 /packages/nodes-base/ 目录下运行。

规则例外#​

除了修复规则违规，您也可以设置例外，使检查工具不再标记该问题。

若需对单个文件设置例外，请添加代码注释。特别注意：TSLint 规则可能不会在 VS Code 中显示，需通过代码注释禁用。更多指引请参阅 TSLint 文档。