0

0

VSCode代码:格式化与规范检查

紅蓮之龍

紅蓮之龍

发布时间:2025-10-20 14:46:01

|

549人浏览过

|

来源于php中文网

原创

配置 Prettier 和 ESLint 可实现 VSCode 保存时自动格式化与规范检查。首先安装 Prettier 和 ESLint 扩展,创建 .prettierrc 定义格式规则,如分号、单引号、行宽等;在 settings.json 中启用 "editor.formatOnSave" 并设置默认格式化工具为 Prettier。接着初始化 ESLint,生成 .eslintrc.js 配置文件,选择环境与规则,集成 "eslint:recommended" 与 "plugin:prettier/recommended",安装 eslint-config-prettier 插件避免规则冲突。最后统一 settings.json:开启保存自动修复 "source.fixAll.eslint",指定验证语言类型,并将配置文件提交版本控制,确保团队一致性。通过本地安装依赖和项目级配置,实现跨设备统一开发体验。

vscode代码:格式化与规范检查

在使用 VSCode 进行开发时,代码的格式化与规范检查能极大提升团队协作效率和代码质量。通过集成工具如 Prettier 和 ESLint,可以实现保存时自动格式化、语法规范校验、错误高亮提示等功能。

配置 Prettier 实现代码格式化

Prettier 是一个流行的代码格式化工具,支持 JavaScript、TypeScript、CSS、HTML、JSON 等多种语言。

安装 Prettier 扩展:
  • 打开 VSCode 扩展市场(Ctrl+Shift+X)
  • 搜索 “Prettier - Code formatter” 并安装
创建配置文件(可选但推荐):

在项目根目录下创建 .prettierrc 文件定义格式规则:

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

启用保存时自动格式化:

  • 打开 VSCode 设置(Ctrl+,)
  • 勾选 “Editor: Format On Save” 或添加如下配置到 settings.json
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode"

集成 ESLint 进行规范检查

ESLint 能帮助发现代码中的潜在问题并强制执行编码规范,尤其适合 JavaScript/TypeScript 项目。

安装 ESLint 扩展:
  • 在扩展中搜索 “ESLint” 并安装由 Microsoft 提供的版本
初始化 ESLint(若项目未配置):
npm init @eslint/config

按照提示选择环境、模块系统、框架等,生成 .eslintrc.js.eslintrc.json 文件。

常见 ESLint 配置示例:

Skybox AI
Skybox AI

一键将涂鸦转为360°无缝环境贴图的AI神器

下载
{
  "env": {
    "browser": true,
    "es2021": true
  },
  "extends": [
    "eslint:recommended",
    "plugin:prettier/recommended"
  ],
  "rules": {
    "no-console": "warn",
    "no-unused-vars": "error"
  }
}

确保 ESLint 与 Prettier 协同工作:

  • 安装依赖:npm install --save-dev eslint-config-prettier
  • extends 中包含 prettier 以关闭冲突规则

统一设置:让编辑器自动处理一切

将格式化与检查流程整合进 VSCode,实现“保存即修复”体验。

推荐 settings.json 配置:
{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "eslint.validate": ["javascript", "typescript", "vue"],
  "editor.defaultFormatter": "esbenp.prettier-vscode"
}

这样,在保存文件时,ESLint 会自动修复可修复的问题,Prettier 完成格式化。

项目级配置优先于全局设置

建议在项目中使用本地安装的工具和配置文件,避免不同机器间差异。

  • 使用 .vscode/settings.json 存放项目专属编辑器设置
  • .prettierrc.eslintrc.* 提交到版本控制
  • 通过 .prettierignore.eslintignore 忽略构建产物

基本上就这些。合理配置后,VSCode 能在你写代码时默默帮你保持风格统一,减少低级错误,提升整体开发体验。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

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

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

804

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

435

2024.06.27

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

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

515

2023.06.20

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

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

244

2023.07.28

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

8

2026.01.30

热门下载

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

精品课程

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

共137课时 | 10.2万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

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