背景
收敛PC和小程序各个项目中常用的工具方法库: @xxx/js-lib 举例:节流 - ahook,手写,lodash。 统一实现标准,保证质量。
方案
实现方案
typedoc 读取方法的函数签名并编译成 markdown,vitepress 将 markdown 转成文档。
doc
开发计划
先用一个方法走通替换流程,其它方法补充完以后,按照需求迭代逐步替换。 比如,在一个迭代里,用到了 trimAll,就替换成 js-lib 中的 trimAll。 接着每月统计一下剩余方法的替换量,直到全部替换完成。
模块划分
按照方法分类,共13个大类,后续看情况扩展新的大类,每个大类单独存放成一个文件夹,每个方法名为单独文件,每个大类下用 index.ts 作为导出入口,单元测试作为一个单独的test文件夹存放每个大类的测试 case,例如:
-js-lib -index.ts // 入口 -String // 大类文件夹 -trimAll.ts // 方法 -index.ts -Array // 大类文件夹 -uniqueArray.ts // 方法 -index.ts -test // 单元测试 -string.text.ts // 测试 case -array.test.ts // 测试 case ......