Skip to content

n8n 节点检查器#

n8n 的节点检查器 @n8n/eslint-plugin-community-nodes 会对社区包中的 n8n 节点和凭据源码进行静态分析（lint）。它可以检测问题并自动修复，帮助您遵循最佳实践。

@n8n/eslint-plugin-community-nodes 包含一组适用于节点文件（*.node.ts）、凭据文件（*.credentials.ts）以及社区包 package.json 的规则集合。

设置#

如果使用 n8n node starter：请在 starter 项目中运行 npm install 以安装所有依赖。安装完成后，即可使用检查器。

如果使用 VS Code，请安装 ESLint VS Code 扩展。对于其他 IDE，请参考它们的 ESLint 集成。

不要编辑配置文件

eslint.config.mjs 包含由 @n8n/node-cli 提供的 ESLint 配置。请不要编辑此文件。

使用#

您可以在社区包或主 n8n 仓库中使用检查器。

检查#

在社区包中，检查器在安装依赖项后和将包发布到 npm 之前自动运行。在主 n8n 仓库中，每当您推送到拉取请求时，检查器都会使用 GitHub Actions 自动运行。

在这两种情况下，VS Code 都会在您处理项目时在后台进行检查。将鼠标悬停在检测到的问题上，可以看到检查的完整描述和进一步信息的链接。

您也可以手动运行检查器：

  • 运行 npm run lint 执行 lint，并在控制台中查看检测到的问题。
  • 运行 npm run lint:fix 执行 lint 并自动修复问题。检查器会修复标记为可自动修复的规则违规。

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

例外#

除了修复规则违规外，您还可以为其创建例外，这样检查器就不会标记它。

要在 VS Code 中创建 lint 例外：将鼠标悬停在问题上，点击 Quick fix（macOS 上为 cmd+.），然后选择 Disable {rule} for this line。只有在确有充分理由时才应为某一行禁用规则。如果您认为检查器错误地报告了问题，请到 n8n 仓库中提交反馈。

要为单个文件添加 lint 例外，请添加代码注释。更多说明请参考 ESLint 文档。