eslint-plugin-rkfe v0.0.1

eslint-plugin-rkfe

Rokid 前端 eslint 自定义规则插件

使用

一般不单独使用该插件包，推荐使用 rkfe-lint工具。
如果要使用，需要在 ESLint 的基础上使用。

Rokid 自定义 lint 规则

下面列举了该插件默认的规则初稿，后续需要团队成员一起完善

• max-params：方法定义入参最多 3 个；更多参数请设计成 options: object 的方式传参

function http(url: string, method: string, headers: object, timeout: number) {} // ❌

function http(url: string, method: string, options: { headers: object, timeout: number }) {} // ✅

• no-oss-domain：代码中不能出现oss原地址，使用cdn路径

const url = 'https://rokid.oss-cn-hangzhou-internal.aliyuncs.com/1.jpg'; // ❌

const url = 'https://img.rokid.com/1.jpg'; // ✅

• no-rokid-domain：不能硬编码业务域名，要通过配置区分环境

location.href = 'https://air.rokid.com/'; // ❌

location.href = link('air'); // ✅

参与开发

• 对每条规则按照规范编写文档和测试用例