luban-ts-service v1.0.2

luban-ts-service

generate typescript interface and service function/class on yapi doc

Install

npm i luban-ts-service -D

Usage

// generate config file
lts init

// generate interface and service functions
lts gen

config file

根目录下的 lts.config.js 会被 lts gen 命令在运行时加载，可以导出一个对象或者一个数组：

module.exports = { }
// or
module.exports = [];

其中， server、token、 output 为必填项；对象或数组的项应满足下面的 Config 类型：

type Config = {
  // 项目地址
  server: string;
  // 项目token
  token: string;
  // 输出目录，默认 `src/service`
  output: string;
  // 获取哪些分类；undefined或者空数组表示获取该项目的所有分类
  categories?: string[];
  // 每个分类对应的生成文件名，指定该项时应该与上面的 `categories` 中的项一一对应
  // 当此配置的长度大于等于 2 且 n + 1 === n 时，n + 1 生成的内容将被追加到 n 中(n 是此处指定的第 n 个文件名)
  categoriesFileName?: string[];
  // 只输出 interface
  onlyInterface?: boolean;
  // 创建请求实例时的名字，亦是创建请求实例的文件名(当再次生成时，若该文件存在，则不会覆盖)
  requestInstanceName?: string;
  // 服务环境变量名称，将作为创建请求实例时的 `baseURL`
  serverEnvName?: string;
  // 指定如何生成导入请求实例的语句
  renderImportInstance?: (name: string) => string;
  // 指定如何生成每个 service function 的 return 部分
  renderServiceFuncReturn?: (url: string, method: string, typeString: string) => string;
  // 过滤不需要生成的 service function
  filterServiceFunc?: (path: string) => boolean;
};