`tsdk.config.js` 说明

在执行完初始化命令后，tsdk 会在当前文件夹生成 tsdk.config.js 配置文件，内容如下：

/** @type {import('tsdk').TSDKConfig} */
module.exports = {
  packageDir: 'packages/',
  packageName: 'fe-sdk',
  baseDir: './src',
  entityLibName: 'typeorm',
  entityExt: 'entity',
  apiconfExt: 'apiconf',
  shareExt: 'shared',
  httpLib: 'axios',
  sharedDirs: ['./src/shared'],
  removeFields: [],
  monorepoRoot: './',
};

字段说明

packageDir - 导出模块到哪个文件夹
packageName - 导出的模块名称
entityLibName - ORM 模块，目前支持 TypeORM, kysely 和 DrizzleORM
entityExt - ORM 数据库表模块文件扩展，默认 *.entity.ts
apiconfExt - API 配置文件扩展，默认 *.apiconf.ts
shareExt - 共享文件名扩展，默认 *.shared.ts
sharedDirs - 共享文件夹，默认 ["./src/shared"]
monorepoRoot - monorepo 根路径，默认当前路径 ./
httpLib - 可选值有 xior | axios，默认 axios; xior 和 axios 什么区别？xior 使用 fetch，API 和 axios 类似
dataHookLib - 可选值有 SWR | ReactQuery，生成 SWR 或者 React Query 钩子；get 方法的接口将生成获取钩子，非 get 的将生成更新钩子。默认不生成。依赖版本：swr@^2.2.4；@tanstack/react-query@^5.10.0
dependencies - 自定义依赖，将会和 fe-sdk/package.json dependencies 进行合并。作用：添加自定义依赖，以及覆盖默认的依赖版本号
devDependencies - 自定义依赖，将会和 fe-sdk/package.json devDependencies 进行合并。

packageDir

packageDir - 导出模块到哪个文件夹

packageName

packageName - 导出的模块名称

entityLibName

entityLibName - ORM 模块，目前支持 TypeORM，kysely 和 DrizzleORM

entityExt

entityExt - ORM 数据库表模块文件扩展，默认 *.entity.ts

apiconfExt

apiconfExt - API 配置文件扩展，默认 *.apiconf.ts

shareExt

shareExt - 共享文件名扩展，默认 *.shared.ts

sharedDirs

sharedDirs - 共享文件夹，默认 ["./src/shared"]

monorepoRoot

monorepoRoot - monorepo 根路径，默认当前路径 ./

`httpLib`

可选值有 xior | axios，默认 axios；

xior 和 axios 什么区别？xior 使用 fetch，API 和 axios 类似

dataHookLib

dataHookLib - 可选值有 SWR | ReactQuery，生成 SWR 或者 React Query 钩子；get 方法的接口将生成获取钩子，非 get 的将生成更新钩子。默认不生成。依赖版本：swr@^2.2.4；@tanstack/react-query@^5.10.0

dependencies

自定义依赖，将会和 fe-sdk/package.json dependencies 进行合并；

适合添加自定义依赖，以及覆盖默认的依赖版本号。比如使用 axios 最新版本：

更新 tsdk.config.js

tsdk.config.js

/** @type {import('tsdk').TSDKConfig} */
module.exports = {
  ...
  dependencies: {
    "axios": "latest"
  }
}

`devDependencies`

自定义依赖，将会和 fe-sdk/package.json devDependencies 进行合并。

代码仓库 APIConfig 说明

tsdk.config.js 说明