创建社区节点规则

其他 社区

技能解读

当前原文的自动摘译,尚未人工审校。

4b.添加到 src/plugin.ts 配置

添加到两个配置对象(除非规则依赖于 n8n 云功能): 将 error 用于捕获错误或所需模式的规则 使用 warn 用于样式/约定规则(如 options-sorted-alphabetically) 如果规则使用 no-restricted-globals 或 no-restricted-imports 模式,则仅添加到 recommended (不recommendedWithoutN8nCloudSupport)

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
通用
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@n8n-io · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
macOS · Linux · Windows
运行环境要求
Node.js
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:了解规则

在编写代码之前,先澄清:该规则检测什么? (缺失属性、错误模式、不良价值)它适用于哪里? (`.node.ts` 文件、凭证类别,两者) 严重性:`error`(必须修复)或 `warn`(应修复)?可以修复吗?它可以安全地自动修复,还是只是建议?

02
第 2 步:实施规则

创建`src/rules/<rule-name>.ts`:命名:导出为`PascalCaseRule`(例如`MissingPairedItemRule`)。 `name` 字段是 kebab-case。可用的 AST 帮助器 - 请参阅 Reference.md 以获取 `ast-utils` 和 `file-utils` 导出的完整目录。

03
第 3 步:编写测试

创建`src/rules/<rule-name>.test.ts`:测试指南:始终测试是否跳过非 INodeType 类(有效情况) 测试错误消息和可修复规则的固定输出 对于带有选项的规则,测试每个选项组合

04
第 5 步:编写文档

创建`docs/rules/<rule-name>.md`:`` will be regenerated by `pnpm build:docs`上方的标题。编写一个合理的第一个版本——它会被覆盖。

05
第 6 步:验证

从`packages/@n8n/eslint-plugin-community-nodes/`运行:

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。