javaScript代码规范 核心是统一协作标准、减少错误、提升可维护性;ESLint 支持按需配置,应优先启用防运行时错误规则,风格类规则团队一致即可,新项目建议启用 strict 模式和 no-console,并集成至编辑器、CI 及 Prettier。

javascript代码规范的核心是统一团队协作标准,减少低级错误,提升可维护性。ESLint 是目前最主流的静态代码检查 工具,它不强制你用某套规则,而是让你按需配置、灵活扩展。
明确规范目标再选规则
制定规范前先想清楚:你们最常踩哪些坑?比如变量命名混乱、忘记处理 promise 错误、随意使用 var、箭头函数写法不一致等。不要一上来就套用 Airbnb 或 google 的整套规则——那些适合大厂,但可能让小团队开发变慢。
- 优先启用能防止运行时错误的规则,比如 no-undef(禁止未声明变量)、no-unused-vars(禁止未使用变量)
- 对风格类规则保持宽容,比如是否加分号、单引号还是双引号,团队达成一致即可,不必强求“最佳”
- 新项目建议开启 strict 模式和 no-console(上线前自动拦截 console)
快速上手 ESLint 配置
在项目根目录运行以下命令安装:
npm init @eslint/config(推荐,交互式引导)
立即学习“Java 免费学习笔记(深入)”;
它会问你:用什么模块系统(Commonjs / ES Module)、是否用 typescript、框架(react / vue)、是否需要 浏览器 环境支持等。回答完自动生成 .eslintrc.js 或 .eslintrc.cjs 配置文件。
你也可以手动创建配置文件,最小可用配置示例如下:
module.exports = {
env: {browser: true, es2021: true},
extends: [‘eslint:recommended’],
parserOptions: {ecmaVersion: ‘latest’, sourceType: ‘module’},
rules: {
‘no-alert’: ‘warn’,
‘no-unused-vars’: ‘Error’
}
};
集成到开发流程中
光有配置不够,得让它真正起作用:
- 编辑器里装 ESLint 插件(VS Code 推荐官方 ESLint 扩展),保存时自动提示并修复简单问题
- 在 package.json 中添加脚本:“lint”: “eslint src/**/*.{js,jsx}”,CI 流程中运行该命令,不通过则阻断发布
- 搭配 Prettier 使用更省心:ESLint 管逻辑和质量,Prettier 管格式美化;用 eslint-config-prettier 关闭 ESLint 中与 Prettier 冲突的规则
团队落地的小技巧
规则不是越严越好,关键是可持续执行:
- 初期只开 5–8 条关键规则,团队熟悉后再逐步增加
- 把常见报错整理成内部 FAQ,比如“‘xxx’is not defined”怎么快速定位
- 允许局部禁用(// eslint-disable-next-line no-console),但要求写明原因,避免滥用
- 定期回顾规则效果:哪些规则天天被绕过?哪些规则明显减少了 bug?及时调整