eslint配置指南

简介

对于初学者来说eslint极其难用，本文介绍如何从0到1配置eslint,让你的项目代码更加的规范美观

1.安装eslint （三种包管理工具任选其一）

• npm i eslint -D
• yarn add eslint -D
• pnpm add eslint -D

2.生成eslint配置文件

• npx eslint --init

配置文件不是一步生成的，这里是要在终端进行进一步的选择，比如你使用的框架，使用的语言，代码模块化的风格等等

3.在配置文件中添加规则

这一步是精髓，eslint的规则有很多大家不需要记忆，具体使用那些规则往往是公司项目领导来决定。这里我准备了一份模板来为大家演示。大家把rules粘贴到自己文件相应的位置即可。

rules: {
		// eslint（https://eslint.bootcss.com/docs/rules/）
		'no-var': 'error', // 要求使用 let 或 const 而不是 var
		'no-multiple-empty-lines': ['warn', { max: 1 }], // 不允许多个空行
		'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
		'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
		'no-unexpected-multiline': 'error', // 禁止空余的多行
		'no-useless-escape': 'off', // 禁止不必要的转义字符

		// typeScript (https://typescript-eslint.io/rules)
		'@typescript-eslint/no-unused-vars': 'error', // 禁止定义未使用的变量
		'@typescript-eslint/prefer-ts-expect-error': 'error', // 禁止使用 @ts-ignore
		'@typescript-eslint/no-explicit-any': 'off', // 禁止使用 any 类型
		'@typescript-eslint/no-non-null-assertion': 'off',
		'@typescript-eslint/no-namespace': 'off', // 禁止使用自定义 TypeScript 模块和命名空间。
		'@typescript-eslint/semi': 'off',

		// eslint-plugin-vue (https://eslint.vuejs.org/rules/)
		'vue/multi-word-component-names': 'off', // 要求组件名称始终为 “-” 链接的单词
		'vue/script-setup-uses-vars': 'error', // 防止<script setup>使用的变量<template>被标记为未使用
		'vue/no-mutating-props': 'off', // 不允许组件 prop的改变
		'vue/attribute-hyphenation': 'off' // 对模板中的自定义组件强制执行属性命名样式
	}

4.package.json scripts中添加脚本

  lint:eslint src
  fix:eslint src --fix

5.在vscode终端 运行命令

• pnpm lint ----用于检查代码是否符合eslint配置的语法规则
• pnpm fix -----用于修复代码eslint检查出的语法错误