README
eslint-config-win
此规则适用于 JavaScript/Vue 项目的 ESLint 配置规范。
目前已支持 Vue 3.0，需要指定 extends 配置vue3
安装
yarn add @winner-fed/eslint-config-win -D
依赖版本
eslint ^7.32.0
babel-eslint ^10.1.0
vue-eslint-parser ^7.11.0
eslint-plugin-vue ^7.20.0
Tips：如果项目中没有安装此依赖包或者版本不一致，请安装或者升级。
用法
- 在你的项目的根目录下创建一个
.eslintrc.js文件，并将以下内容复制进去：
module.exports = {
extends: [
'@winner-fed/win',
],
env: {
// 你的环境变量（包含多个预定义的全局变量）
//
// browser: true,
// node: true,
// mocha: true,
// jest: true,
// jquery: true
},
globals: {
// 你的全局变量（设置为 false 表示它不允许被重新赋值）
//
// myGlobal: false
},
rules: {
// 自定义你的规则
}
};
- 项目目录下的
package.json添加检测指令，举个例子
{
...
"scripts": {
+ "lint:es": "eslint \"src/**/*.{vue,js,jsx}\" --fix",
}
...
}
Vue
npm install --save-dev eslint babel-eslint vue-eslint-parser eslint-plugin-vue @winner-fed/eslint-config-win
在你的项目的根目录下创建一个 .eslintrc.js 文件，并将以下内容复制进去：
module.exports = {
extends: [
'@winner-fed/win',
// 这里是针对 vue2 的配置
'@winner-fed/win/vue',
// 如果是 vue3 的项目工程，则推荐下面配置
// '@winner-fed/win/vue3',
],
env: {
// 你的环境变量（包含多个预定义的全局变量）
//
// browser: true,
// node: true,
// mocha: true,
// jest: true,
// jquery: true
},
globals: {
// 你的全局变量（设置为 false 表示它不允许被重新赋值）
//
// myGlobal: false
},
rules: {
// 自定义你的规则
}
};
Vue3 新增规则
参考
开发维护
- 以测试开发驱动，config/rules/*.json 文件都是根据 test/ 文件夹对应的生成的