完整的开发流程 #

流程示意图 #

拆分步骤描述 #

1. 初始化项目

创建项目package.json文件（pkg文件），初步配置项目信息并安装项目所需依赖包。

2. 创建合理的文件结构

参考下一页项目结构

3. 配置Eslint和Prettier统一代码风格

校验和自动修正代码风格的工具，由我司内部开发的@cosfee/eslint-config包统一提供。

4. 配置Typescript开发环境

tsconfig.json文件中配置语言编译项。

5. 构建工具配置

通过配置构建工具tsup的config文件（也可以直接在命令行中配置参数）来调节编译、打包和输出流程。

6. 配置Git提交规范

配置Git提交规范的标准格式和命令式交互界面。

7. 编排脚本命令

配置合适的npm script脚本命令，便于执行运行代码、打包程序、格式化和跑单元测试等任务。

8. 开始编写代码

9. watch 模式开发(本地服务)

在Nodejs环境中运行本地代码并监听热更新处理。

10. 添加单元测试，编写测试示例

11. 本地运行测试用例

• 运行测试用例文件；
• 分析测试结果，修复代码；

12. 输出测试覆盖率文件

13. 完善pkg文件必要字段

如入口文件、对外暴露的输出文件、导出的Js模块风格等。

14. 编写README.md文件

书写使用教程和对外提供调用的api。

15. 走发布流程

• 如果有需要提前打包输出文件；
• 更新包版本号；
• 添加changelog信息；
• 检查上传私库的地址和版本号，执行发布。

16. 代码提交和存档

• 代码push到git仓库；
• 打Tag标签（与所发布私库的版本号对应一致），推送标签到远程仓库。