.eslintrc.cjs

const { defineConfig } = require("eslint-define-config");

// @see: http://eslint.cn
module.exports = defineConfig({
	root: true,
	env: {
		es6: true,
		browser: true,
		node: true,
	},
	plugins: ["@typescript-eslint", "prettier"],
	// 继承某些已有的规则
	extends: ["eslint:recommended", "plugin:import/recommended", "plugin:@typescript-eslint/recommended", "prettier"],
	settings: {
		// 确保 ESLint 和 eslint-plugin-import 能够正确解析项目中的所有相关文件类型
		"import/resolver": {
			node: { extensions: [".js", ".mjs", ".ts", ".d.ts", ".tsx"] },
		},
	},
	overrides: [
		{
			files: ["*.ts", "*.vue", "*.tsx"],
			rules: {
				// 关闭 - 禁止使用未声明的变量，除非/*global *\/注释中提到
				"no-undef": "off",
			},
		},
		{
			files: ["*.d.ts"],
			rules: {
				// 关闭 - 禁止在文件中重复导入相同的模块
				"import/no-duplicates": "off",
			},
		},
		{
			files: ["*.js"],
			rules: {
				// 关闭 - 不允许使用 require 语句
				"@typescript-eslint/no-var-requires": "off",
			},
		},
		{
			files: ["*.cjs"],
			rules: {
				// 关闭 - 不允许使用 require 语句
				"@typescript-eslint/no-var-requires": "off",
				"@typescript-eslint/no-require-imports": "off",
			},
		},
	],
	/**
	 * "off" 或 0    ==>  关闭规则
	 * "warn" 或 1   ==>  打开的规则作为警告（不影响代码执行）
	 * "error" 或 2  ==>  规则作为一个错误（代码不能执行，界面报错）
	 */
	rules: {
		// JS/TS (http://eslint.cn/docs/rules)

		// 强制使用 camelCase 命名风格
		camelcase: [
			"error",
			{
				// 允许对象属性使用非 camelCase 风格
				properties: "never",
			},
		],
		// 禁止使用控制台
		"no-console": [
			"warn",
			{
				// 允许除 warn/error 之外的其他 console.xx 方法
				allow: ["warn", "error"],
			},
		],
		// 禁止使用 debugger
		"no-debugger": "warn",
		// 禁止在条件语句中使用常量条件
		"no-constant-condition": [
			"error",
			{
				// 允许在循环语句中使用常量条件
				checkLoops: false,
			},
		],
		// 禁止使用某些特定的语法
		"no-restricted-syntax": [
			"error",
			// 禁止使用标记语句（labeled statements）
			"LabeledStatement",
			// 禁止使用 with 语句
			"WithStatement",
		],
		// 禁止在 return 语句中使用 await
		"no-return-await": "error",
		// 禁止使用 var 关键字，强制使用 let 或 const
		"no-var": "error",
		// 禁止使用空的块语句
		"no-empty": [
			"error",
			{
				// 允许空的 catch 块
				allowEmptyCatch: true,
			},
		],
		// 该规则禁止使用不规则或不标准的空白字符
		"no-irregular-whitespace": "error",
		// 禁止在函数或变量定义之前使用它们
		"no-use-before-define": "warn",
		// 强制使用 const 声明不被修改的变量
		"prefer-const": [
			"warn",
			{
				// 在解构赋值时也推荐使用 const
				destructuring: "all",
				// 允许在变量首次赋值前读取变量的值
				ignoreReadBeforeAssign: true,
			},
		],
		// 强制使用箭头函数而非普通函数
		"prefer-arrow-callback": [
			"error",
			{
				// 不允许使用命名函数作为回调函数
				allowNamedFunctions: false,
				// 允许在箭头函数中使用 this 绑定的上下文
				allowUnboundThis: true,
			},
		],
		// 强制使用对象字面量的方法和属性简写语法
		"object-shorthand": [
			"error",
			"always",
			{
				// 不忽略构造函数中的属性简写
				ignoreConstructors: false,
				// 强制避免在属性名中使用引号
				avoidQuotes: true,
			},
		],
		// 强制使用 rest 参数代替 arguments 对象
		"prefer-rest-params": "error",
		// 强制使用展开运算符（...）代替 Function.prototype.apply
		"prefer-spread": "error",
		// 强制使用模板字面量代替字符串连接
		"prefer-template": "error",
		// 禁止在同一作用域中重新声明变量
		"no-redeclare": "error",

		// 最佳实践
		// 确保数组的回调函数（如 Array.prototype.map、Array.prototype.filter、Array.prototype.reduce 等）总是有一个返回值
		"array-callback-return": "error",
		// 强制使用块级作用域变量（let 或 const），避免使用函数作用域变量（var）
		"block-scoped-var": "error",
		// 禁止使用 alert、confirm 和 prompt 等浏览器弹出对话框
		"no-alert": "warn",
		// 禁止在 switch 语句的 case 或 default 子句中声明变量
		"no-case-declarations": "error",
		// 禁止使用多行字符串，即不允许使用反斜杠 \ 来连接多行字符串
		"no-multi-str": "error",
		// 禁止使用 with 语句
		"no-with": "error",
		// 禁止使用 void 操作符
		"no-void": "error",
		// 禁止多个空行
		"no-multiple-empty-lines": [
			"error",
			{
				// 最多允许1行
				max: 1,
			},
		],

		// import 排序
		"sort-imports": [
			"warn",
			{
				// 不忽略导入语句中模块名的大小写
				ignoreCase: false,
				// 忽略导入声明的排序
				ignoreDeclarationSort: true,
				// 不忽略导入成员的排序
				ignoreMemberSort: false,
				// 成员语法排序顺序
				memberSyntaxSortOrder: ["none", "all", "multiple", "single"],
				// 不允许分组导入
				allowSeparatedGroups: false,
			},
		],

		// 强制在数学运算中使用 ** 运算符代替 Math.pow()
		"prefer-exponentiation-operator": "error",

		// TS (https://typescript-eslint.io/rules)

		// 要求在导出函数和类的公共方法上显式声明返回类型
		"@typescript-eslint/explicit-module-boundary-types": "off",
		// 要求在 TypeScript 函数和方法中显式地指定返回类型
		"@typescript-eslint/explicit-function-return-type": "error",
		// 禁止在同一作用域中重新声明 TypeScript 变量
		"@typescript-eslint/no-redeclare": "error",
		// 允许定义未使用的变量
		"@typescript-eslint/no-unused-vars": "off",
		// 允许使用自定义TypeScript模块和命名空间
		"@typescript-eslint/no-namespace": "off",
		// 允许使用 any 类型
		"@typescript-eslint/no-explicit-any": "off",
		// 禁止在 TypeScript 文件中使用 require 函数进行模块导入
		"@typescript-eslint/no-var-requires": "error",
		// 禁止定义空函数
		"@typescript-eslint/no-empty-function": "error",
		// 禁止无用的表达式
		"@typescript-eslint/no-unused-expressions": [
			"error",
			{
				// 允许短路操作符（&& 和 ||）中的无副作用表达式
				allowShortCircuit: true,
				// 允许三元操作符中的无副作用表达式
				allowTernary: true,
			},
		],
		// 禁止在 TypeScript 代码中对类型已经可以被推断的变量或参数进行显式的类型注解
		"@typescript-eslint/no-inferrable-types": "error",
		// 禁止使用后缀运算符的非空断言(!)
		"@typescript-eslint/no-non-null-assertion": "error",
		// 禁止在可选链(?)后使用非空断言(!)
		"@typescript-eslint/no-non-null-asserted-optional-chain": "error",
		// 禁止在代码中使用 @ts-ignore 注释
		"@typescript-eslint/ban-ts-comment": ["error", { "ts-ignore": false }],
		// 一致地使用 TypeScript 类型导入
		"@typescript-eslint/consistent-type-imports": [
			"error",
			{
				// 允许使用类型注解
				disallowTypeAnnotations: false,
			},
		],

		// 确保 Prettier 错误被 ESLint 捕获
		"prettier/prettier": "error",

		// import

		// 确保所有的 import 语句位于文件的顶部，紧接在文件的开头部分，且在任何其他代码之前
		"import/first": "error",
		// 禁止在同一文件中出现重复的 import 语句
		"import/no-duplicates": "error",
		// 导入模块排序风格
		"import/order": [
			"error",
			{
				// 导入模块分组
				groups: [
					// Node.js 内置模块
					"builtin",
					// 第三方模块
					"external",
					[
						// 项目内部模块
						"internal",
						// 父级目录中的模块
						"parent",
						// 具有相同父级的模块
						"sibling",
						// 当前目录的 index.js 或 index.ts 文件
						"index",
						"object",
						// "type",
					],
					"unknown",
				],
				pathGroups: [
					{
						pattern: "vue",
						group: "external",
						position: "before",
					},
					{
						pattern: "@vue/**",
						group: "external",
						position: "before",
					},
					{
						pattern: "@gejia-element-plus/**",
						group: "internal",
					},
				],
				pathGroupsExcludedImportTypes: ["type"],
				// 禁止不同组之间进行换行
				"newlines-between": "never",
				//根据字母顺序对每个组内的顺序进行排序
				alphabetize: {
					order: "asc",
					caseInsensitive: true,
				},
			},
		],
		// 关闭 - 禁用对无法解析的模块导入的检查
		"import/no-unresolved": "off",
		// 关闭 - 禁用对命名空间导入（例如，import * as）的检查
		"import/namespace": "off",
		// 关闭 - 禁用对默认导入的检查
		"import/default": "off",
		// 关闭 - 禁用对以默认导出方式作为命名导入的检查
		"import/no-named-as-default": "off",
		// 关闭 - 禁用对将默认导出成员当作命名导入的检查
		"import/no-named-as-default-member": "off",
		// 关闭 - 禁用对命名导入（即从模块中导入特定命名的内容）的检查
		"import/named": "off",
	},
});