使用 Monorepo + pnpm + TypeScript + unbuild + API Documenter + tsDoc 开发 JS SDK 库

使用 Monorepo + pnpm + TypeScript + unbuild + API Documenter + tsDoc 开发 JS SDK 库

本文将详细介绍如何使用 Monorepo、pnpm、TypeScript、unbuild、API Documenter 和 tsDoc 开发一个 JS SDK 库。

1. 创建 Monorepo

首先，创建一个 Monorepo，可以使用 lerna 或者 yarn workspace 等工具。Monorepo 能够帮助你将所有相关项目集中管理，例如 JS SDK 库、示例项目等。

2. 创建 packages 目录

在 Monorepo 中创建一个 packages 目录，用于存放所有的子项目，包括你的 JS SDK 库。

3. 创建 JS SDK 目录

在 packages 目录中创建一个 jssdk 目录，用于存放 JS SDK 库的代码。

4. 初始化 JS SDK 项目

使用 pnpm 在 jssdk 目录中初始化项目，创建一个 package.json 文件：

cd packages/jssdk
  pnpm init -y

5. 添加依赖

在 package.json 文件中添加必要的依赖，例如：

• typescript: 用于编写 TypeScript 代码
• unbuild: 用于编译打包代码
• api-documenter: 用于生成 API 文档
• tsDoc: 用于生成类型定义文件

  "dependencies": {
    "@types/node": "^18.11.18",
    "@types/pnpm": "^7.11.0"
  },
  "devDependencies": {
    "api-documenter": "^8.0.0",
    "typescript": "^4.9.4",
    "unbuild": "^2.0.2",
    "ts-doc": "^0.18.0",
    "@types/unbuild": "^2.0.1"
  }

6. 创建 src 目录

在 jssdk 目录中创建一个 src 目录，用于存放 JS SDK 库的源代码。

7. 编写源代码

使用 TypeScript 编写 JS SDK 库的源代码。你可以使用面向对象的方式，将 JS SDK 库的功能封装在一个类中。

8. 创建 build 目录

在 jssdk 目录中创建一个 build 目录，用于存放编译后的代码。

9. 添加编译脚本

在 package.json 文件中添加编译脚本，使用 TypeScript 编译 JS SDK 库源代码，并将编译后的代码输出到 build 目录中。

  "scripts": {
    "build": "tsc && tsc-watch --onSuccess "pnpm run build:cjs && pnpm run build:esm && pnpm run docs:generate""
  }

10. 打包

使用 unbuild 工具，将 build 目录中的编译后的代码打包成一个 npm 包。

  "scripts": {
    "build:cjs": "unbuild --cjs --dir=dist/cjs",
    "build:esm": "unbuild --esm --dir=dist/esm"
  }

11. 生成文档

使用 API Documenter 和 tsDoc 工具，生成 JS SDK 库的 API 文档和类型定义文件。

  "scripts": {
    "docs:generate": "api-documenter --config .api-documenter.json",
    "docs:serve": "api-documenter serve"
  }

12. 创建其他项目

在 Monorepo 中创建其他子项目，如示例项目等，使用 JS SDK 库进行开发和测试。

总结

使用 Monorepo + pnpm + TypeScript + unbuild + API Documenter + tsDoc 开发一个 JS SDK 库，可以更好地管理代码和依赖，提高代码的可读性、可维护性和可测试性，并且可以方便地生成 API 文档和类型定义文件，为其他项目提供良好的接口。