0

0

在VSCode中使用ESLint和Prettier规范代码风格

P粉986688829

P粉986688829

发布时间:2025-12-29 11:12:02

|

703人浏览过

|

来源于php中文网

原创

ESLint与Prettier可在VSCode中协同工作以自动规范JS/TS代码风格:需安装对应扩展和本地依赖,配置.eslintrc.cjs禁用冲突规则,通过.prettierrc定义格式选项,并在settings.json中启用保存时自动修复与格式化。

如果您在vscode中编写javascripttypescript代码,但发现格式混乱、缩进不一致、分号缺失等问题,则可能是未正确配置eslint与prettier协同工作。以下是实现二者共存并自动规范代码风格的步骤:

本文运行环境:MacBook Air,macOS Sequoia。

一、安装必要扩展与依赖

VSCode本身不内置ESLint和Prettier功能,需通过官方扩展和项目级依赖启用校验与格式化能力。扩展提供编辑器集成,本地依赖确保规则可复现且与团队一致。

1、打开VSCode扩展市场,搜索并安装ESLint(作者:Microsoft)与Prettier(作者:Esben Petersen)两个扩展。

2、在项目根目录执行命令行操作:npm init -y初始化package.json(若尚未存在)。

3、运行命令安装开发依赖:npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin(适用于TS项目;若仅JS,可省略ts相关包)。

二、配置ESLint基础规则

ESLint负责代码质量检查,其规则需通过.eslintrc.cjs文件声明。该配置将启用推荐规则,并禁用与Prettier冲突的格式类规则,避免重复报错。

1、在项目根目录创建文件.eslintrc.cjs

2、写入以下内容:

module.exports = {

extends: [

'eslint:recommended',

'plugin:@typescript-eslint/recommended',

'plugin:prettier/recommended'

],

parser: '@typescript-eslint/parser',

plugins: ['@typescript-eslint', 'prettier'],

rules: { 'prettier/prettier': 'error' }

};

三、配置Prettier格式化选项

Prettier专注代码样式统一,其行为由.prettierrc文件控制。该文件定义缩进、引号、换行等视觉细节,确保每次保存都生成相同格式的代码。

1、在项目根目录创建文件.prettierrc

2、写入以下JSON内容:

Summarizer
Summarizer

基于 AI 的文本段落摘要生成器

下载

{

"semi": true,

"singleQuote": true,

"tabWidth": 2,

"trailingComma": "es5",

"printWidth": 80

}

四、设置VSCode自动修复与保存行为

VSCode需明确知道何时调用ESLint修复、何时触发Prettier格式化,以及二者优先级关系。通过settings.json配置可实现保存时自动应用全部规则。

1、按下Cmd+,(macOS)打开VSCode设置界面,点击右上角打开设置(JSON)图标。

2、在settings.json中添加以下键值对:

"editor.formatOnSave": true,

"editor.codeActionsOnSave": { "source.fixAll.eslint": true },

"eslint.validate": ["javascript", "typescript", "javascriptreact", "typescriptreact"],

"prettier.requireConfig": true,

"editor.defaultFormatter": "esbenp.prettier-vscode"

五、验证配置是否生效

配置完成后需通过真实代码触发校验与格式化流程,确认错误提示、自动修复及保存格式化均按预期响应。

1、新建一个test.js文件,输入内容:const a=1; console.log(a)(无分号、无空格、单引号缺失)。

2、保存文件,观察左侧问题面板是否出现ESLint警告(如“Missing semicolon”),同时代码是否自动变为const a = 1;console.log(a);

3、右键编辑器空白处,选择格式化文档,确认光标所在文件被重排为符合.prettierrc定义的样式。

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

199

2026.02.25

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

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

83

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

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

493

2023.10.18

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号