n8n 节点代码检查工具

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

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/ 目录下运行。

例外情况

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

在 VS Code 中创建检查例外：将鼠标悬停在问题上并点击 Quick fix（在 macOS 上是 cmd+.），然后选择 Disable {rule} for this line。仅在您有充分理由的情况下才为某行禁用规则。如果您认为检查器错误地报告了问题，请在检查器仓库中报告。

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