0

0

用Prettier和ESLint规范你的代码:VSCode配置教程

P粉986688829

P粉986688829

发布时间:2025-12-24 19:24:09

|

338人浏览过

|

来源于php中文网

原创

Prettier负责代码格式化,ESLint负责检测问题,二者配合是主流前端代码规范方案;VSCode安装对应插件并配置.eslintrc.cjs、.prettierrc等文件,启用保存时自动修复即可实现统一风格与错误预防。

用prettier和eslint规范你的代码:vscode配置教程

想让团队代码风格统一、减少低级错误?Prettier 负责格式化,ESLint 负责找问题,两者配合是目前最主流的前端代码规范方案。VSCode 里配好一次,写代码时自动修复,省心又专业。

安装必要插件和依赖

先确保 VSCode 已安装两个核心插件:

  • Prettier(官方插件,ID:esbenp.prettier-vscode
  • ESLint(官方插件,ID:dbaeumer.vscode-eslint)

项目本地也需要装对应依赖,推荐使用 npm:

npm install --save-dev prettier eslint eslint-config-prettier eslint-plugin-react eslint-plugin-react-hooks

如果用 TypeScript,再加:eslint-plugin-import @typescript-eslint/eslint-plugin @typescript-eslint/parser

配置 ESLint 规则文件

在项目根目录新建 .eslintrc.cjs(或 .js/.json),内容示例如下:

module.exports = {
  root: true,
  env: { browser: true, es2021: true, node: true },
  extends: [
    'eslint:recommended',
    'plugin:react/recommended',
    'plugin:react-hooks/recommended',
    'prettier' // 关闭与 Prettier 冲突的规则
  ],
  parser: '@typescript-eslint/parser',
  plugins: ['react', 'react-hooks', '@typescript-eslint'],
  rules: {
    'no-console': 'warn',
    'react/prop-types': 'off',
    'react/react-in-jsx-scope': 'off'
  }
};

注意:extends 中的 prettier 必须放在最后,才能正确覆盖前面的冲突规则。

In3D
In3D

把真人变成化身,创建逼真且可自定义的虚拟角色

下载

配置 Prettier 并对接 ESLint

新建 .prettierrc 文件,定义格式偏好:

{
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "es5",
  "printWidth": 80
}

再建 .eslintignore.prettierignore,排除 node_modules、dist 等目录。关键一步:在 settings.json(工作区或用户设置)中启用自动修复:

"editor.codeActionsOnSave": {
  "source.fixAll.eslint": true
},
"eslint.validate": ["javascript", "typescript", "typescriptreact", "html"],
"prettier.requireConfig": true,

这样保存文件时,ESLint 就会调用 Prettier 自动格式化 + 修复可修复的问题。

避免常见坑

几个容易出错但很好解决的点:

  • 多个项目规则不一致?用 工作区设置(.vscode/settings.json)替代全局设置
  • 保存没反应?检查是否启用了 editor.codeActionsOnSave,且文件类型在 eslint.validate 列表中
  • Prettier 报错说“配置未找到”?确认 prettier.requireConfig 设为 true,且项目根目录有 .prettierrc
  • React 组件报 react/prop-types 错误?按需关闭,或装 eslint-plugin-prop-types 补充校验

基本上就这些。配完你会发现,代码提交前不再需要手动调整缩进、引号、分号——编辑器已经帮你做好了。

热门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 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

197

2026.02.25

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

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

76

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数据方法,阅读专题下面的文章了解更多详细内容。

83

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

531

2023.06.20

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

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

69

2026.03.13

热门下载

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

精品课程

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

共58课时 | 6.1万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1.1万人学习

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

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