dsj_npm_eslint_plugin

小步创想eslint规则

安装

先安装 eslint:

$ npm i eslint --save-dev

然后安装 eslint-plugin-xbcx:

$ npm install eslint-plugin-xbcx --save-dev

使用

添加 xbcx 到项目的 .eslintrc 配置文件. 可以省略 eslint-plugin- 前缀:

{
    "plugins": [
        "xbcx"
    ]
}

添加了插件还需要定义规则，因为我们的规则默认没有开启，如下:

{
    "rules": {
        "xbcx/no-record-time": 2
    }
}

目录结构

• /lib/rules/*.js --规则文件
• /tests/lib/rules/*.js --单元测试文件

备注

• 自定义eslint规则必须符合语法规范
• 如果有fix需求，需要声明fixable，否则不生效
• 规则必须提供单元测试用例
• 自定义的eslint规则npm包，必须用eslint-plugin- 前缀
• ESlint文档