JS 中单元测试代码规范制定指南怎么写

老伟姑娘_7234

老伟姑娘_7234

2026-10-23

713人浏览

原创

js单元测试规范需与项目代码规范对齐,强调可读、可维护、可信任;遵循aaa结构、显式mock、语义化断言、边界覆盖及工程化约束。

js 中单元测试代码规范制定指南怎么写

JS 单元测试代码规范不是独立存在的,它必须和项目整体的 JavaScript 代码规范对齐,核心是让测试代码本身具备可读、可维护、可信任的特质。重点不在“写多少测试”,而在于“每一条测试是否清晰表达意图、稳定可靠、易于演进”。

测试文件与结构统一

保持测试组织方式一致,降低团队理解成本。

  • 文件命名严格使用 .test.js 或 .spec.js 后缀(如 utils.test.js),确保测试运行器自动识别
  • 测试文件与被测源码放在同一目录(如 src/utils/formatDate.js 对应 src/utils/formatDate.test.js),避免跨层引用路径混乱
  • 用 describe() 按功能模块或函数名分组,每个 describe 描述一个明确上下文(如 describe('formatDate()', () => { ... }))
  • 每个 test() 只验证一个具体行为,名称用完整句子,以动词开头、含输入和预期(如 test('returns "2023-01-01" for new Date(2023, 0, 1))

测试逻辑编写有章法

测试代码不是自由发挥,它需要遵循明确的行为契约。

chartjs-reporter
chartjs-reporter

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

下载
  • 坚持 AAA 结构:Arrange(准备输入/模拟依赖)→ Act(调用被测函数)→ Assert(断言结果),不混写
  • 所有外部依赖(fetch、localStorage、第三方库)必须显式 mock,不走真实调用(用 vi.mock() 或 jest.mock())
  • 异步测试必须显式等待:用 async/await 或返回 Promise,禁止在回调里写 expect 而不 return
  • 避免在测试中使用 setTimeout 等不可控延时;需测定时逻辑时,用 vi.advanceTimersByTime() 或 jest.runAllTimers()

断言与可维护性兼顾

断言是测试的“判决书”,既要准,也要让人一眼看懂错在哪。

  • 优先使用语义化匹配器:toBe() 判等值,toEqual() 深比较对象,toThrow() 验证异常,不直接用 === 或 ==
  • 每个 test() 块只设一个主断言(核心输出),最多加 1–2 个辅助断言(如 mock 函数调用次数 mockFn.mock.calls.length)
  • 边界场景必须覆盖:空值、null、undefined、非法类型、极值、错误响应——这些不是“额外工作”,而是防止线上崩溃的关键防线
  • 不测私有实现细节(如内部变量、未导出的辅助函数),只测公开 API 行为;若某段逻辑复杂且独立,应先抽成导出函数再测

工具链与工程化约束

靠人盯不如靠机制,把规范固化到开发流程中。

  • 在 vitest.config.ts 或 jest.config.js 中启用 globals: true,确保 test、describe、beforeEach 全局可用,避免 ReferenceError
  • 配合 ESLint 添加测试专属规则,如禁止未使用的变量(no-unused-vars)、强制 expect 有匹配器(jest/valid-expect)
  • 通过 husky + lint-staged 在 git commit 前自动运行测试,失败则阻断提交
  • CI 流程中要求测试覆盖率达标(如函数覆盖率 ≥ 80%),但不盲目追求 100%,重质量而非数字

相关专题

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

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

2023.06.20

5126

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

5044

6

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

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

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1916

5

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

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

2023.09.04

3605

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4693

6

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

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

2023.09.20

3080

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万人学习