eslint-plugin-zving-specifications

0.3.0 • Public • Published

eslint-plugin-zving-specifications

eslint-plugin-zving-specifications 是一个ESLint插件,对代码中如下写法作出警告:

  • 为了减少打包后js文件体积,不允许导入整个 lodash 库,请导入你需要的特定的 lodash 函数
  • 不允许命名全局变量
  • moment 建议改为 dayjs
  • 根据 static/modules-info.json 提示模块是否存在
  • 不允许写cookie

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-zving-specifications:

$ npm install eslint-plugin-zving-specifications --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-zving-specifications globally.

Usage

Add zving-specifications to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "zving-specifications"
    ]
}

rules说明

no-full-import: 'warn' //不允许引入lodash、lodash-compat、rambda或date-fns的整个依赖包

no-option-cookie: 'warn' // 不允许操作cookie

no-add-object-to-window: [1, makeException]
  作用:不允许修改window对象中的方法,不允许给window对象添加属性
  参数说明 -- [可选]
  makeException: type: Array, 当给window添加特定的属性时不检测

big-package-replace:'warn' // 或 [1, packageConfig]
  作用:需要替代的大体积依赖包
  参数说明 -- [可选]:
  packageConfig: [{ name: 'xx', replaceName: 'aa' }]
  name: 需要检测的依赖名称
  replaceName: 替换的依赖名称

eslint -> rules配置示例

{
  "rules": {
    // "zving-specifications/rule-name": 2,
    'no-full-import': 1,
    'no-option-cookie': 1
    'big-package-replace': 1,
    'no-add-object-to-window': 1,
  }
}

Supported Rules

  • Fill in provided rules here

Package Sidebar

Install

npm i eslint-plugin-zving-specifications

Weekly Downloads

18

Version

0.3.0

License

MPL

Unpacked Size

33.1 kB

Total Files

11

Last publish

Collaborators

  • abeet