JavaScript 如何配置 ESLint

平时写代码时,是不是经常遇到这样的情况:明明自己觉得写的逻辑没问题,可同事接过来看一眼就说“这里格式不对”,或者上线后才发现因为少写了个分号导致报错?这不是故意找茬,而是团队协作里的代码规范在“拖后腿”。ESLint就是帮你解决这个问题的工具,它像个“代码语法家教”,能自动帮你揪出格式和逻辑上的小问题,还能统一团队的代码风格。

第一步:先装基础工具

要配置ESLint,得先把它“请”进你的项目里。现在做前端基本都用npm包管理,打开项目的命令行,输入一行命令就行。如果是个人小项目,直接装到本地就行,不会影响别人;如果是团队项目,记得把ESLint加到开发依赖里,这样其他人克隆项目后,只要安装依赖就能用。装完后,项目根目录会多一个node_modules文件夹,还有package.json,这就是工具的“落脚点”。

JavaScript 如何配置 ESLint

第二步:生成配置文件

装完工具后,还得告诉ESLint“该怎么管代码”,这就需要一个配置文件。在项目根目录新建一个叫.eslintrc.js的文件(也可以用.json格式,不过.js更灵活,能写简单判断),内容不用写太复杂,先从最基础的开始。比如如果你的代码是给浏览器用的,就告诉ESLint“允许用window这个全局变量”;如果是用Vue框架写的,就加对应的插件。这里不用急着写满所有规则,先把适配自己项目的基础配置加上,比如规定“每个代码块后面要加分号”“变量名不能用单字母除了循环计数器”,这些都是团队容易统一的小规则。

第三步:关联编辑器和自动修复

光有配置文件还不够,总不能每次写完代码都手动跑一遍ESLint检查吧?要是用VS Code编辑器,装个ESLint插件就行。装完后,打开设置,开启“保存文件时自动修复ESLint错误”,这样写代码时,只要一保存,格式不对的地方会自动改好,比如把tab换成空格,把多余的空格删掉,就像你写作业时,写完自动帮你把错字擦掉重写一样。如果是团队项目,还可以加个规则,比如“变量定义了就必须用”,避免出现写了一半忘了用的冗余代码。

第四步:给项目加检查脚本

最后一步是把ESLint加到项目的运行脚本里,这样不管是谁,只要跑个命令就能检查所有代码。打开package.json,在"scripts"里加一行"lint": "eslint src",这里的src是你放代码的文件夹,ESLint会自动扫描里面的所有JS文件。要是有人写的代码不符合规范,运行这个命令就会把问题列出来,比如“第10行少了分号”“第15行变量名不符合驼峰规则”,这样不用翻整个代码就能快速修改。如果遇到特殊情况,比如临时测试的代码想跳过检查,也可以在那行代码上面加一行// eslint-disable-next-line,告诉ESLint“这次放过它”,灵活度也有了。

刚开始用ESLint可能会觉得有点麻烦,改几次规则、适应几次自动修复就习惯了。等你项目多了就会发现,统一的代码规范能省超多时间,不用再跟同事争论“分号到底要不要写”,也不用上线后再找那种低级错误。ESLint就是这么个“省心小助手”,帮你把精力放在写业务逻辑上,而不是纠结格式对错。

上一篇 TypeScript ts-expect-error 怎么用