Skip to content

nuxt3的Eslint配置

通过官方脚手架功能生成项目发现啥都没配: npx nuxi@latest init my-app

安装依赖

bash
pnpm add -D @nuxtjs/eslint-config-typescript @typescript-eslint/eslint-plugin eslint

新增script脚本

js
"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
}

配置eslintrc

js
// .eslintrc.cjs
// 规则参见:https://cn.eslint.org/docs/rules/
module.exports = {
  root: true,
  // 指定项目环境,可以调用node和浏览器端的全局API
  env: {
    browser: true,
    node: true
  },
  parser: 'vue-eslint-parser', // 这个parser自带
  parserOptions: {
    sourceType: 'module'
  },
  plugins: ['@typescript-eslint'],
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    '@nuxtjs/eslint-config-typescript'
  ],
  // 自定义规则,可以覆盖 extends 的配置【安装Eslint插件可以静态检查本地文件是否符合以下规则】
  rules: {
    // 0: 关闭规则(允许)  1/2: 警告warning/错误error(不允许)
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    indent: ['error',
      2
    ], // 缩进:2
    quotes: ['error', 'single'
    ], // 引号:single单引 double双引
    semi: ['error', 'never'
    ], // 结尾分号:never禁止 always必须
    'vue/no-multiple-template-root': 0,
    'comma-dangle': ['error', 'never'
    ], // 对象拖尾逗号
    'no-redeclare': ['error',
      { builtinGlobals: true }
    ], // 禁止重复对象声明
    'space-before-function-paren': 0, // 函数定义时括号前面空格
    'one-var': 0, // 允许连续声明
    'no-undef': 0, // 允许未定义的变量
    'linebreak-style': 0, // 检测CRLF/LF检测【默认LF】
    'no-extra-boolean-cast': 0, // 允许意外的Boolean值转换
    'no-constant-condition': 0, // if语句中禁止常量表达式
    'no-irregular-whitespace': 0, // 允许不规则的空白符
    'no-prototype-builtins': 0, // 允许使用Object.prototypes内置对象(如:xxx.hasOwnProperty)
    'no-regex-spaces': 0, // 允许正则匹配多个空格
    'no-unexpected-multiline': 0, // 允许多行表达式
    'no-fallthrough': 0, // 允许switch穿透
    'no-delete-var': 0, // 允许 delete 删除对象属性
    'no-mixed-spaces-and-tabs': 0, // 允许空格tab混用
    'no-class-assign': 0, // 允许修改class类型
    'no-param-reassign': 0, // 允许对函数params赋值
    'max-len': 0, // 允许长行
    'func-names': 0, // 允许命名函数
    'import/no-unresolved': 0, // 不检测模块not fund
    'import/prefer-default-export': 0, // 允许单个导出
    'unicorn/error-message': 0,
    'no-return-assign': 0,
    'no-new-func': 0,
    'no-empty': 1, // 空语句块
    'no-const-assign': 1, // 警告:修改const命名的变量
    'no-unused-vars': 1, // 警告:已声明未使用
    'no-unsafe-negation': 1, // 警告:使用 in / instanceof 关系运算符时,左边表达式请勿使用 ! 否定操作符
    'use-isnan': 1, // 警告:使用 isNaN() 检查 NaN
    'no-var': 2, // 禁止使用var声明
    'no-empty-pattern': 2, // 空解构赋值
    eqeqeq: 2, // 必须使用 全等=== 或 非全等 !==
    'no-cond-assign': 2, // if语句中禁止赋值
    'no-dupe-args': 2, // 禁止function重复参数
    'no-dupe-keys': 2, // 禁止object重复key
    'no-duplicate-case': 2,
    'no-func-assign': 2, // 禁止重复声明函数
    'no-inner-declarations': 2, // 禁止在嵌套的语句块中出现变量或 function 声明
    'no-sparse-arrays': 2, // 禁止稀缺数组
    'no-unreachable': 2, // 禁止非条件return、throw、continue 和 break 语句后出现代码
    'no-unsafe-finally': 2, // 禁止finally出现控制流语句,如:return、throw等,因为这会导致try...catch捕获不到
    'valid-typeof': 2, // 强制 typeof 表达式与有效的字符串进行比较
    // auto format options
    'prefer-const': 0, // 禁用声明自动化
    'no-extra-parens': 0, // 允许函数周围出现不明括号
    'no-extra-semi': 2, // 禁止不必要的分号
    curly: ['error', 'multi'
    ], // if、else、for、while 语句单行代码时不使用大括号
    'dot-notation': 0, // 允许使用点号或方括号来访问对象属性
    'dot-location': ['error', 'property'
    ], // 点操作符位置,要求跟随下一行
    'no-else-return': 2, // 禁止if中有return后又else
    'no-implicit-coercion': [
      2,
      {
        allow: ['!!', '~', '+'
        ]
      }
    ], // 禁止隐式转换,allow字段内符号允许
    'no-multi-spaces': 0, // 关闭空格规则
    'no-useless-return': 0,
    'wrap-iife': 0, // 允许自调用函数
    yoda: 0, // 允许yoda语句
    strict: 0, // 允许strict
    'no-undef-init': 0, // 允许将变量初始化为undefined
    'prefer-promise-reject-errors': 0, // 允许使用非 Error 对象作为 Promise 拒绝的原因
    'consistent-return': 0, // 允许函数不使用return
    'no-new': 0 // 允许单独new
  }
}

WARNING

注意重启vscode!