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内容:

Metafox企业内容管理系统0.9.1
Metafox企业内容管理系统0.9.1

Metafox 是一个企业内容管理系统,使用一个特别的模板系统,你可通过一些特定的设计和代码来轻松创建 Web 网站,内容存储在 SQL 关系数据库,通过 Web 进行管理,简单、快速而且高效。 Metafox 0.9.1 发布,该版本改用一种更棒的 URL 风格,实现了 RSS 源(可包含远端网站内容到 Metafox 段中),重定向老的访问密钥到新的密钥,增加 RotateAntispam 技

下载

{

"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定义的样式。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

538

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

372

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

727

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

390

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

989

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

653

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

540

2023.09.20

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

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

精品课程

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

共58课时 | 3.1万人学习

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

共12课时 | 0.9万人学习

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

共12课时 | 1万人学习

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

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