跳到主要内容

n8n 节点 linter

n8n 节点 linter @n8n/eslint-plugin-community-nodes 对社区软件包中的 n8n 节点和凭据源代码执行静态分析(lint),发现问题并自动修复,帮助遵循最佳实践。

@n8n/eslint-plugin-community-nodes 包含一组规则,用于检查社区软件包的节点文件(*.node.ts)、凭据文件(*.credentials.ts)和 package.json。

设置 ​

使用 n8n 节点入门项目时,在项目中运行 npm install 安装全部依赖,安装完成后即可使用 linter。

使用 VS Code 时,请安装 ESLint VS Code 扩展。其他 IDE 请参阅各自的 ESLint 集成说明。

信息

不要编辑配置文件

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

用法 ​

可在社区软件包或 n8n 主仓库中使用 linter。

执行 lint 检查 ​

社区软件包在安装依赖后、发布到 npm 前会自动运行 linter。在 n8n 主仓库中,每次向拉取请求推送时,会通过 GitHub Actions 自动运行。

这两种情况下,VS Code 都会在开发时于后台执行 lint 检查。将鼠标悬停在问题上,可查看完整说明及更多信息链接。

也可手动运行 linter:

  • 运行 npm run lint,执行 lint 检查并在控制台查看问题。
  • 运行 npm run lint:fix,执行 lint 检查并自动修复问题。linter 只自动修复标记为可自动修复的规则违规。

两个命令均可在社区软件包根目录运行,或在主仓库的 /packages/nodes-base/ 中运行。

例外 ​

除了修正规则违规,也可为特定情况设置例外,使 linter 不再报告。

在 VS Code 中设置 lint 例外:悬停在问题上,按 Quick fix(macOS 为 cmd+.),选择 Disable {rule} for this line(对此行禁用该规则)。只有理由充分时,才为单行禁用规则。如果认为 linter 误报,请向 n8n 仓库报告。

要为单个文件添加 lint 例外,请添加代码注释。更多指南请参阅 ESLint 文档。

相关资源 ​

本文为社区中文翻译。查看对应英文原文