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/ 中运行。

例外#

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

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

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