diff --git a/docs/test.md b/docs/test.md index fcd8bf8..9099464 100644 --- a/docs/test.md +++ b/docs/test.md @@ -5,14 +5,11 @@ 单元测试是一个项目最基础的测试,也是一个项目质量保证的第一关,所以确保一定的单元测试覆盖率还是很重要的。我们项目的单元测试使用了业界内比较受欢迎的 `jest` ,文档完善,生态发展也不错,也比较适合来写单元测试。 ### 目录介绍 目前我们的单元测试放在根目录下的 `test` 目录,下面是具体的目录介绍: -- config 主要用来存放与编辑器默认配置相关的测试文件; -- editor 主要用来存放与编辑器构造器相关的测试文件; -- fns 主要用来存放一些帮助方便测试的 `utils`; -- menus 主要用来存放菜单功能的测试文件; -- text 主要用来存放文本处理相关的测试文件; -- utils 主要用来存放项目 `utils` 相关的测试文件; +- helpers 用来存放配合测试的一些 utils; +- setup 用来引入一些更加方便我们测试的 `jest` 库,比如在这里我们就引入了 `jest-dom` 来配合我们测试 HTML 相关的部分; +- unit 主要用来存放所有单元测试文件,里面就基本按我们项目核心代码的目录结构存放对应的单元测试,比如 editor 目录就是存放编辑器相关的测试文件,以此类推。 -可以看到,单元测试目录结构基本是跟项目核心代码的结构保持一致的,这样也让我可以很清晰地定位到相关功能的测试文件。 +可以看到,单元测试目录结构职责还是比较分明,unit下的测试文件基本是跟项目核心代码的结构保持一致的,这样也让我可以很清晰地定位到相关功能的测试文件。 ### 编写测试 可以根据你需要测试的功能选择对应的目录创建测试文件,目前的目录结构基本满足了编辑器所有功能了。如果之前没有写过或者学习过单元测试的同学,可以先去 [jest](https://jestjs.io/) 官网先进行一定的学习,再加入到单元测试中来。