tdp-public-sdk

TDP Public SDk

项目介绍

该项目为 TDP 部门前端 SDK 管理和开发仓库，采用 pnpm（参考：https://www.pnpm.cn/） 搭建 monorepo（参考：https://zhuanlan.zhihu.com/p/513171061） 工程管理模块，它不再分多个 git 仓库，而是在一个 git 仓库里面管理多个项目，每个项目有自己的 package.json 文件，有自己的 node_modules 目录。开发阶段使用 Esbuild（参考：https://esbuild.github.io/） 打包应用，保证开发响应速度，生产阶段使用 Rollup（参考：https://www.rollupjs.com/） 打包应用，生成多种文件格式，满足不同平台使用。

安装使用

• 获取项目代码

git clone https://gitlab.xpaas.lenovo.com/tdp/data-modeler/tdp-web-platform/tdp-public-sdk.git

• 安装依赖

该项目使用 pnpm 软件包管理器(请先安装 pnpm)

npm install -g pnpm

如果是根目录,会安装根目录依赖和所有 packages 依赖

cd tdp-public-sdk

pnpm install

• 单独向根目录安装依赖,所有项目公用依赖（workspace）

pnpm add xxx -w

• 内部依赖安装

指定命令空间 @test/lib，指定为 @test/app 添加依赖

$ pnpm i @test/lib --filter @test/app

• 特定 package 增加外部依赖

--filter 为制定 package 添加依赖

pnpm add lodash --filter @test/lib

• 开发

开发环境使用 esbuild 打包

pnpm dev

• dev 单独打包 packages 内的项目

   "dev": "node scripts/dev.js 具体打包项目名称 -f esm",

• 生产打包

将 packages 所有项目打包

pnpm build

• build 单独打包 packages 内的项目

请见 scripts/build.js 注释内容

Git Hooks

git hooks 工具 husky,规范提交格式。（详情请查看 commitlint.config.js） git commit 阶段会经过多种 lint 检查,pretty 代码格式化检查，注意你提交的代码是否符合 lint 规则。（详情请查看 package.json）

packages 各模块 package.json

针对 rollup 打包

"buildOptions": {
        "name": "TDPWebMonitorSDK",
        "formats": [
            "esm-browser",
            "esm-bundler",
            "cjs",
            "global"
        ],
        "sourcemap": false,
        "env": "development"
    }

参数说明

名称	作用
name	打包后对外暴露方法
formats	支持打包的文件格式
sourcemap	支持 sourcemap
env	环境