eslint.config.js

import js from '@eslint/js';
import pluginTypeScript from '@typescript-eslint/eslint-plugin';
import * as parserTypeScript from '@typescript-eslint/parser';
import configPrettier from 'eslint-config-prettier';
import { defineFlatConfig } from 'eslint-define-config';
import importPlugin from 'eslint-plugin-import';
import pluginPrettier from 'eslint-plugin-prettier';
import pluginVue from 'eslint-plugin-vue';
import * as parserVue from 'vue-eslint-parser';

console.log(
  '\x1B[0;37;44m INFO \x1B[0m',
  '\x1B[0;;34m ' + `读取了: eslint配置文件` + ' \x1B[0m'
);

export default defineFlatConfig([
  {
    ...js.configs.recommended,
    ...importPlugin.flatConfigs.recommended,
    ignores: [
      'node_modules',
      'pnpm-lock.yaml',
      'dist',
      'components.d.ts',
      'auto-imports.d.ts',
      'electron-dist/**/*',
      'deploy/**/*',
      '.DS_Store',
      '.eslintcache',
    ],
    languageOptions: {
      globals: {},
    },
    plugins: {
      prettier: pluginPrettier,
      import: importPlugin,
    },
    rules: {
      ...configPrettier.rules,
      ...pluginPrettier.configs?.recommended.rules,
      /**
       * 0 => off
       * 1 => warn
       * 2 => error
       */
      'no-unused-vars': 'off', // 禁止出现未使用过的变量
      'no-shadow': 'off', // 禁止变量声明与外层作用域的变量同名
      'class-methods-use-this': 'off', // 类方法如果不使用this的话会报错
      'no-console': 'off', // 此规则不允许调用console对象的方法。
      'spaced-comment': ['error', 'always', { exceptions: ['-', '+'] }], // 该规则强制注释中 // 或 /* 后空格的一致性
      'no-var': 'error', // 要求let或const代替var
      camelcase: [
        'error',
        { properties: 'never' }, // properties默认always，即检查属性名；可以设置为never，即不检查属性名
      ], // 强制执行驼峰命名约定
      'no-underscore-dangle': 'error', // 此规则不允许在标识符中使用悬空下划线。
      'no-param-reassign': 'error', // 禁止对 function 的参数进行重新赋值
      'no-nested-ternary': 'error', // 禁止嵌套三元
      'no-plusplus': 'error', // 禁用一元操作符 ++ 和 --
      'vars-on-top': 'error', // 要求所有的 var 声明出现在它们所在的作用域顶部
      'prefer-const': 'error', // 要求使用 const 声明那些声明后不再被修改的变量
      'prefer-template': 'error', // 要求使用模板字符串代替字符串连接
      'new-cap': 'error', // 要求构造函数名称以大写字母开头
      'no-restricted-syntax': [
        // 禁用一些语法
        'error',
        // 'ForInStatement',
        // 'ForOfStatement',
        {
          selector: 'ForInStatement',
          /**
           * 用 map() / every() / filter() / find() / findIndex() / reduce() / some() / ... 遍历数组，
           * 和使用 Object.keys() / Object.values() / Object.entries() 迭代你的对象生成数组。
           * 拥有返回值得纯函数比这个更容易解释
           */
          message:
            'for in会迭代遍历原型链(__proto__)，建议使用map/every/filter等遍历数组，使用Object.{keys,values,entries}等遍历对象',
        },
        {
          selector: 'ForOfStatement',
          message:
            '建议使用map/every/filter等遍历数组，使用Object.{keys,values,entries}等遍历对象',
        },
      ], // https://github.com/BingKui/javascript-zh#%E8%BF%AD%E4%BB%A3%E5%99%A8%E5%92%8C%E5%8F%91%E7%94%9F%E5%99%A8
      'no-iterator': 'error', // 禁止使用__iterator__迭代器
      'require-await': 'error', // 禁止使用不带 await 表达式的 async 函数
      'no-empty': 'error', // 禁止空块语句
      'guard-for-in': 'error', // 要求for-in循环包含if语句
      'global-require': 'error', // 此规则要求所有调用require()都在模块的顶层，此规则在 ESLint v7.0.0中已弃用。请使用 中的相应规则eslint-plugin-node：https://github.com/mysticatea/eslint-plugin-node
      'no-unused-expressions': [
        'error',
        {
          allowShortCircuit: true, // 允许短路
          allowTernary: true, // 允许三元
        },
      ], // 禁止未使用的表达式，即let a = true && console.log(1)允许，但是true && console.log(1)不行
      'object-shorthand': ['error', 'always'], // （默认）希望尽可能使用速记。var foo = {x:x};替换为var foo = {x};
      'no-useless-escape': 'error', // 禁止不必要的转义字符

      'import/order': [
        'error',
        {
          groups: [
            'builtin', // 如:import fs from 'fs';
            'external', // 如:import _ from 'lodash';
            'internal', // 如:import foo from 'src/foo';
            'parent', // 如:import foo from '../foo';
            'sibling', // 如:import bar from './bar';
            // ['sibling', 'parent'],
            // ['parent', 'sibling'],
            'index', // 如:import main from './';
            'object', // 如:import log = console.log;
            'type', // 如:import type { Foo } from 'foo';
          ],
          pathGroups: [
            {
              pattern: '@/**',
              group: 'internal',
            },
          ],
          'newlines-between': 'always', // 强制或禁止导入组之间的新行
          // 根据导入路径以字母顺序排列每个组中的顺序
          alphabetize: {
            order: 'asc', // 使用asc按升序排序，使用desc按降序排序（默认值：ignore）。
            caseInsensitive: true, // 使用true忽略大小写，而false考虑大小写（默认值：false）。
            orderImportKind: 'asc', // 使用asc以升序对各种导入类型进行排序，例如以type或typeof为前缀的导入，具有相同的导入路径。使用desc按降序排序（默认值：忽略）
          },
        },
      ],
      'import/newline-after-import': 'error', // 强制在最后一个顶级导入语句或 require 调用之后有一个或多个空行
      'import/no-extraneous-dependencies': 'error', // 禁止导入未在package.json中声明的外部模块。
    },
  },
  {
    files: ['**/*.?([cm])ts', '**/*.?([cm])tsx'],
    languageOptions: {
      parser: parserTypeScript,
      parserOptions: {
        sourceType: 'module',
      },
    },
    plugins: {
      '@typescript-eslint': pluginTypeScript,
    },
    rules: {
      ...pluginTypeScript.configs.strict.rules,

      // @typescript-eslint插件
      '@typescript-eslint/no-unused-vars': 'error',

      // '@typescript-eslint/restrict-template-expressions': [
      //   'error',
      //   {
      //     allowBoolean: true,
      //     allowNumber: true,
      //   },
      // ], // 强制模板文字表达式为string类型。即const a = {};console.log(`${a}`);会报错
      '@typescript-eslint/no-floating-promises': 'off', // 要求适当处理类似 Promise 的语句。即将await或者return Promise，或者对promise进行.then或者.catch
      '@typescript-eslint/no-explicit-any': 'off', // 不允许定义any类型。即let a: any;会报错
      '@typescript-eslint/no-non-null-assertion': 'off', // 禁止使用非空断言（后缀运算符!）。即const el = document.querySelector('.app');console.log(el!.tagName);会报错
      '@typescript-eslint/ban-ts-comment': 'off', // 禁止使用@ts-<directive>注释
      '@typescript-eslint/no-unsafe-assignment': 'off', // 不允许将具有类型的值分配any给变量和属性。即const a: any = {};const b = a;会报错
      '@typescript-eslint/no-unsafe-argument': 'off', // 不允许用any类型的值调用一个函数。即let a: any;Object.keys(a);会报错
      '@typescript-eslint/no-unsafe-member-access': 'off', // 不允许对类型为any的值进行成员访问。即const a: any = [];console.log(a[0]);会报错
      '@typescript-eslint/no-unsafe-return': 'off', // 不允许从一个函数中返回一个类型为any的值
      '@typescript-eslint/no-unsafe-call': 'off', // 不允许调用any类型的值
      '@typescript-eslint/no-var-requires': 'off', // 即不允许var foo = require('foo');。但是允许import foo = require('foo');
      '@typescript-eslint/restrict-plus-operands': 'off', // 要求加法的两个操作数是相同的类型并且是bigint, number, 或string。即const a = '1';console.log(a + 1);会报错
      '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
    },
  },
  {
    files: ['**/*.vue'],
    languageOptions: {
      globals: {},
      parser: parserVue,
      parserOptions: {
        ecmaFeatures: {
          jsx: true,
        },
        extraFileExtensions: ['.vue'],
        parser: '@typescript-eslint/parser',
        sourceType: 'module',
      },
    },
    plugins: {
      vue: pluginVue,
    },
    processor: pluginVue.processors['.vue'],
    rules: {
      ...pluginVue.configs.base.rules,
      ...pluginVue.configs['vue3-essential'].rules,
      ...pluginVue.configs['vue3-recommended'].rules,
      'vue/multi-word-component-names': 'off',
    },
  },
]);