/**
 * @description eslint配置文件
 * @extends https://cn.eslint.org/docs/rules/
 */

module.exports = {
  // 1.根目录：当前 .eslintrc.js 所在目录即为根目录，eslint 规则将被限制到该目录下
  root: true,
  // 2.检测环境
  env: {
    browser: true, // 在浏览器环境下启动 eslint，使用 canvas 相关 interface 不会报错
    node: true, // 在node环境下启动 eslint，使用 require 相关 interface 不会报错
    es2021: true
  },
  // 3.解析器
  parserOptions: {
    parser: '@typescript-eslint/parser', // 使用 @typescript-eslint/parser 解析 ts 代码
    ecmaVersion: 'latest',
    sourceType: 'module'
  },
  // 4.插件
  plugins: [
    '@typescript-eslint', // 使用 @typescript-eslint/eslint-plugin 校验 ts 代码
    'prettier' // eslint-plugin-prettier 指定 eslint 使用 prettier 格式化代码
  ],
  // 5.扩展：配置eslint预设规则
  extends: [
    'eslint:recommended', // 使用 eslint 中 recommended 规则
    'plugin:@typescript-eslint/recommended', // 使用 @typescript-eslint/eslint-plugin 中 recommended 规则
    'plugin:prettier/recommended', // 使用 eslint-plugin-prettier 中 recommended 规则
    'prettier' // 使用 eslint-config-prettier 关闭两者冲突规则
  ],
  // 6.自定义规则
  /**
   * "off" 或 0 - 关闭规则
   * "warn" 或 1 - 开启规则，使用警告级别的错误(不会导致程序退出)
   * "error" 或 2 - 开启规则，使用错误级别的错误(当被触发的时候，程序会退出)
   */
  rules: {
    'no-console': 'warn', // [警告]使用console
    'no-debugger': 'warn', // [警告]使用debugger
    '@typescript-eslint/no-unused-vars': 'error', // [错误]存在未使用变量
    '@typescript-eslint/ban-ts-comment': 'warn', // [警告]使用ts禁令注释
    '@typescript-eslint/no-empty-function': 'warn' // [警告]存在空函数
  }
}