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 必须放在最后,才能正确覆盖前面的冲突规则。

微信小程序三个视图控件的示例代码
微信小程序三个视图控件的示例代码

微信小程序中三个视图控件View、ScrollView、Swiper的使用示范,及各个参数配置,附带教程和完善的代码注释。具体教程请在演示地址中查看。

下载

配置 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 补充校验

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

相关专题

更多
json数据格式
json数据格式

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

400

2023.08.07

json是什么
json是什么

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

528

2023.08.23

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

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

305

2023.10.13

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

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

67

2025.09.10

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

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

505

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

240

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

246

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5193

2023.08.17

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

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

精品课程

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

共58课时 | 2.9万人学习

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

共12课时 | 0.9万人学习

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

共12课时 | 1.0万人学习

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

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