SepVeneto/apiGenerator

自动生成API声明文件

根据接口自动生成ts声明文件

示例

api.js

export default {
  /**
   * 登录
   * @param {string} name 用户名
   * @param {string} pass 密码
   * @returns
   */
  login(name, pass) {
    return http({
      method: 'post',
      url: '/login',
      data: { name, pass }
    }, true)
  },
}

api.d.ts

export default interface api {
  /**
   * 登录
   * @param {string} name 用户名
   * @param {string} pass 密码
   * @returns
   */
  login(name: string, pass: string): Promise<Response>
}

使用

默认执行当前目录下的modules的所有js文件，每个js文件都会生成一个独立的d.ts文件。

参数的类型声明全部依赖注释结构

  /**
   * 函数的使用说明
   * @param {参数的类型，默认是any} 参数名 针对参数的注释
   * @returns {返回值的类型，默认是Promise} 返回值注释
   */

编译

tsc

执行

node main.js

执行参数

Usage: generate [options]

Options:
  -d, --dir [p]        项目所在的绝对路径（针对全局引入）
  -m, --module [p]     需要生成声明文件的API文件所在目录（针对局部引入） (default: "api/modules")
  -a, --assign <p...>  为指定API生成声明（基于dir，默认当前项目）
  -v, --verbose        输出更新日志
  -h, --help           display help for command

关于NPM

由于没有发布，只能本地局部引入或全局引入

# 克隆源码后
npm pack
# 局部引入
npm install --save-dev <本地路径>/apiGenerator
# 全局引入
npm link

关于原函数的差分判断

针对每一个函数的注释、形参、形参类型、返回值、返回值类型，任意一个改变都会触发声明的更新