0.5.0-beta.1 • Published 1 year ago

@polyv/eslint-config v0.5.0-beta.1

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

保利威前端工程 ESLint 通用配置

用法

安装配置

npm install @polyv/eslint-config --save-dev

此外,根据工程使用的技术栈,还需要安装以下依赖:

依赖纯 JS 工程纯 TS 工程Vue.js 工程(JS)
eslint
eslint-plugin-import
eslint-plugin-node
eslint-plugin-promise
eslint-plugin-sonarjs
@babel/core
@babel/eslint-parser
typescript
@typescript-eslint/eslint-plugin
@typescript-eslint/parser
eslint-plugin-vue
vue-eslint-parser
@vue/eslint-config-standard

调用配置

创建 .eslintrc.js(一般在工程根目录下创建),并配置 extends 字段:

/* eslint-env node */

// 纯 JS 工程的配置
module.exports = {
  root: true,
  extends: [
    './node_modules/@polyv/eslint-config/lib/for-js'
  ]
};
/* eslint-env node */

// 纯 TS 工程的配置
module.exports = {
  root: true,
  extends: [
    './node_modules/@polyv/eslint-config/lib/for-js',
    './node_modules/@polyv/eslint-config/lib/for-ts'
  ]
};
/* eslint-env node */

// Vue.js 工程(JS)的配置
module.exports = {
  root: true,
  extends: [
    './node_modules/@polyv/eslint-config/lib/for-vue'
  ]
};

devWarnProdError

部分规则在 NODE_ENVproduction 时,告警级别为错误,其他情况下为警告。这些规则包括:

  • no-debugger
  • no-unused-vars
  • no-constant-condition
  • no-empty
  • @typescript-eslint/no-unused-vars
  • @typescript-eslint/explicit-module-boundary-types