n8n 节点检查工具#

n8n的节点检查工具eslint-plugin-n8n-nodes-base会对官方仓库和社区包中的n8n节点及凭证源代码进行静态分析（"检查"）。该检查器能发现问题并自动修复，帮助您遵循最佳实践。

eslint-plugin-n8n-nodes-base 包含针对节点文件(*.node.ts)、资源描述文件(*Description.ts)、凭证文件(*.credentials.ts)以及社区包package.json的规则集合。

设置#

如果使用n8n node starter：在初始项目中运行npm install来安装所有依赖项。安装完成后，您就可以使用代码检查工具了。

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

用法#

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

代码检查#

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

在这两种情况下，当你在项目中工作时，VS Code 会在后台进行代码检查。将鼠标悬停在检测到的问题上，即可查看完整的检查描述以及指向更多信息的链接。

你也可以手动运行linter：

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

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

异常#

除了修复规则违规，你也可以为其创建例外，这样linter就不会标记它。

要在VS Code中设置lint例外：将鼠标悬停在问题上并点击Quick fix（在macOS中使用cmd+.）然后选择禁用此行的{rule}规则。仅在你有充分理由时才禁用某行的规则。如果你认为linter错误地报告了问题，请在linter仓库中报告。

要为单个文件添加lint例外，请添加代码注释。特别是TSLint规则可能不会在VS Code中显示，可能需要通过代码注释来关闭。更多指导请参考TSLint文档。