JS 中 Vite 代码规范制定与团队开发指南怎么写

星涛君_8043

星涛君_8043

2026-10-22

951人浏览

原创

vite需搭配eslint 9.x+prettier 3.x+flat配置实现规范检查与格式化:用eslint.config.js替代.eslintrc.*,eslint专注质量、prettier专责格式,editorconfig兜底统一编辑器基础设置,husky+lint-staged保障提交前自动校验。

js 中 vite 代码规范制定与团队开发指南怎么写

直接上手配置,别绕弯子。Vite 本身不带代码检查和格式化能力,它只负责快打包、热更新;ESLint 和 Prettier 才是管规范的核心工具。当前(2026年)主流组合是 ESLint 9.x + Prettier 3.x + flat config 配置方式,旧的 .eslintrc.js 写法已不兼容,硬套会报错。

用 eslint.config.js 替代 .eslintrc.js

ESLint 9 强制使用扁平化配置,所有规则写在一个数组里,顺序即优先级:

  • 新建 eslint.config.js,不要留 .eslintrc.* 文件,否则冲突
  • 基础配置可复用官方推荐:import js from '@eslint/js',它已内置 eslint:recommended
  • Vue 项目加 import vue from 'eslint-plugin-vue',并显式启用 vue/vue3-essential 规则集
  • TypeScript 项目必须配 @typescript-eslint/eslint-plugin 和 @typescript-eslint/parser,否则无法解析 .ts 或 .vue 中的 TS 语法

Prettier 不要让 ESLint 管格式

ESLint 9 已移除大部分格式类规则,Prettier 应专责格式化,ESLint 专注质量检查。二者协同关键在隔离职责:

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 安装 prettier 和 eslint-config-prettier,后者用于关闭 ESLint 中所有与 Prettier 冲突的规则
  • 不要装 eslint-plugin-prettier 并设为 error —— 这会让格式问题变成构建失败,违背“开发阶段友好”原则
  • 推荐做法:保存时 VS Code 自动用 Prettier 格式化;提交前用 lint-staged 做一次强制校验,但不阻断编辑流程

EditorConfig 是跨编辑器底线保障

VS Code、WebStorm、Nova 等编辑器行为不一致?靠 .editorconfig 统一基础编码习惯:

  • 根目录建 .editorconfig,内容简洁明确,例如缩进用 2 空格、LF 换行、末尾空行、去除行尾空格
  • VS Code 需装 EditorConfig 插件才生效;WebStorm 默认支持,无需额外操作
  • 它不替代 ESLint/Prettier,而是兜底——哪怕某人没装插件,打开文件也不会突然变成 4 空格或 CRLF

Git 提交前自动校验(可选但强烈建议)

靠人自觉不现实,把检查塞进提交流程最省力:

  • 用 husky 初始化 Git hooks,再配 lint-staged 只检查暂存区文件
  • 命令示例:npx husky add .husky/pre-commit "npx lint-staged"
  • lint-staged 配置中,对 *.{js,ts,vue} 跑 eslint --fix,对 *.{js,ts,jsx,tsx,css,scss,vue} 跑 prettier --write
  • 这样既保证提交代码合规,又不会因全量扫描拖慢日常开发

相关专题

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

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

2023.06.20

5106

5

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

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

2023.07.04

1249

3

js四舍五入
js四舍五入

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

2023.07.04

5024

6

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

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

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1896

5

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

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

2023.09.04

3585

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4673

6

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

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

2023.09.20

3060

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

988

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习