eslint-config-sets

eslint-config-sets

eslint 规则预设

安装依赖

vue 安装插件

npm install -D eslint-plugin-vue eslint-plugin-vue-scoped-css eslint-plugin-prettier eslint-config-prettier eslint-plugin-jsdoc babel-eslint eslint prettier vue-eslint-parser

vue3.0 安装插件

npm install -D eslint-plugin-vue eslint-plugin-jsdoc eslint-plugin-vitest-globals eslint-plugin-import eslint-plugin-vue-scoped-css eslint-plugin-prettier eslint-config-prettier babel-eslint eslint prettier vue-eslint-parser

vue3.0 typescript 版本安装插件

npm install -D eslint-plugin-vue eslint-plugin-tsdoc eslint-plugin-vitest-globals eslint-plugin-import eslint-plugin-prettier eslint-config-prettier babel-eslint eslint prettier vue-eslint-parser @typescript-eslint/eslint-plugin @typescript-eslint/parser typescript

vue3.0 typescript library 版本安装插件

npm install -D eslint-plugin-vue eslint-plugin-tsdoc eslint-plugin-vitest-globals eslint-plugin-import eslint-plugin-prettier eslint-config-prettier babel-eslint eslint prettier vue-eslint-parser @typescript-eslint/eslint-plugin @typescript-eslint/parser typescript

react 安装插件

npm install -D eslint-plugin-jsdoc babel-eslint eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint prettier

react typescript 安装插件

npm install -D eslint-plugin-tsdoc babel-eslint eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-import eslint prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser typescript

egg 安装插件

npm install -D eslint-config-egg eslint prettier babel-eslint

simple 安装插件

npm install -D eslint prettier babel-eslint

simple typescript 安装插件

npm install -D eslint prettier babel-eslint eslint-plugin-tsdoc @typescript-eslint/eslint-plugin @typescript-eslint/parser typescript

nuxt 安装插件

npm install -D eslint prettier babel-eslint @nuxtjs/eslint-config @nuxtjs/eslint-module eslint-config-prettier eslint-plugin-jsdoc eslint-plugin-nuxt eslint-plugin-prettier@8.x vue-eslint-parser

使用

配置说明

eslint-config-sets 包含了下面这几套配置

• egg: eggjs 项目
• nuxt: 基于 nuxt 的项目
• react: create-react-app 创建的项目
• reactTs: create-react-app 创建的 typescript 项目
• vue: vue 全家桶项目
• vue3: vue3.0 项目
• vue3Ts: vue3.0 typescript 项目
• vue3TsLib: vue3.0 typescript library 项目
• simple: node lib 项目
• simpleTs: node lib typescript 项目

引入方法

1. 在 vue3.0 项目中使用

   // .eslintrc.js
   const { vue3: config } = require('eslint-config-sets')
   module.exports = Object.assign(config, {
       rules: {
           // 自定义规则
           // semi: [2, 'never']
       }
   })
   

2. 在 vue3.0 typescript 项目中使用

   // .eslintrc.js
   const { vue3Ts: config } = require('eslint-config-sets')
   // ...同上
   

3. 在 vue3.0 typescript library 项目中使用

   // .eslintrc.js
   const { vue3TsLib: config } = require('eslint-config-sets')
   // ...同上
   

4. 在 react 项目中使用

   // .eslintrc.js
   const { react: config } = require('eslint-config-sets')
   // ...同上
   

5. 在 react typescript 项目中使用

   // .eslintrc.js
   const { reactTs: config } = require('eslint-config-sets')
   // ...同上
   

6. 在 egg 项目中使用

   // .eslintrc.js
   const { egg: config } = require('eslint-config-sets')
   // ...同上
   

7. 在 nuxt 项目中使用

   // .eslintrc.js
   const { nuxt: config } = require('eslint-config-sets')
   // ...同上
   

8. 在 js lib 项目中使用

   // .eslintrc.js
   const { simple: config } = require('eslint-config-sets')
   // ...同上