0

0

怎样进行JavaScript代码规范_ESLint和Prettier如何配置

夢幻星辰

夢幻星辰

发布时间:2025-12-24 17:20:02

|

309人浏览过

|

来源于php中文网

原创

JavaScript代码规范需ESLint与Prettier协同:ESLint校验逻辑(如未声明变量),Prettier统一风格(缩进、引号等);通过eslint-config-prettier桥接冲突,配合Husky、lint-staged和编辑器插件实现自动化检查与格式化。

怎样进行javascript代码规范_eslint和prettier如何配置

JavaScript代码规范的核心是统一团队协作标准,ESLint负责代码质量检查(比如未声明变量、重复定义),Prettier专注格式化(缩进、换行、引号等)。两者配合使用效果最佳:ESLint做逻辑校验,Prettier做风格统一分工明确。

安装和基础配置 ESLint

在项目根目录运行以下命令安装 ESLint 及推荐插件:

  • npm install --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin(支持 TypeScript)
  • npx eslint --init 启动交互式配置向导,选择环境(如 Browser/Node)、是否使用 TypeScript、框架(React/Vue)、模块系统(ESM/CommonJS)、代码规范(如 Airbnb 或 Standard)
  • 生成 .eslintrc.js.eslintrc.json,可手动补充规则,例如禁止 var 声明:
    rules: { 'no-var': 'error' }

安装和配置 Prettier

Prettier 默认不依赖配置文件,但建议显式创建 .prettierrc 便于团队同步风格:

  • npm install --save-dev prettier
  • 新建 .prettierrc 文件,内容示例:
    { "semi": true, "singleQuote": true, "tabWidth": 2, "trailingComma": "es5" }
  • 添加 .prettierignore 忽略不需要格式化的文件(如 dist/node_modules/

让 ESLint 和 Prettier 协同工作

默认情况下 ESLint 和 Prettier 规则可能冲突(比如 ESLint 要求分号,Prettier 配置为不加分号),需用插件桥接:

Insou AI
Insou AI

Insou AI 是一款强大的人工智能助手,旨在帮助你轻松创建引人入胜的内容和令人印象深刻的演示。

下载

立即学习Java免费学习笔记(深入)”;

  • npm install --save-dev eslint-config-prettier eslint-plugin-prettier
  • .eslintrc.jsextends 中末尾加入:
    'plugin:prettier/recommended'(关闭 ESLint 中与 Prettier 冲突的规则)
  • 确保 plugins: ['prettier']rules: { 'prettier/prettier': 'error' } 已启用,使 Prettier 检查也作为 ESLint 错误提示

集成到开发流程

提升落地效果的关键是自动化:

  • package.json 中添加脚本:
    "lint": "eslint src/", "format": "prettier --write src/"
  • 配合 Git Hook:用 Husky + lint-staged 实现提交前自动检查并修复:
    安装后配置 lint-staged 对暂存区 JS/TS 文件执行 eslint --fix && prettier --write
  • 编辑器中安装 ESLint 和 Prettier 插件(如 VS Code 的 ESLint 和 Prettier 扩展),开启 formatOnSave 并设置默认格式化工具为 Prettier

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

49

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

196

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

56

2026.03.13

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

888

2023.07.31

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 9.6万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号