@lexmin0412/code-generator v0.1.0

Code Generator

代码生成工具，如将 OpenAPI JSON Schema 转换为 TypeScript 代码。

Install

# 局部安装
pnpm add @lexmin0412/api-code-generator -D
# 全局安装
pnpm install @lexmin0412/api-code-generator -g

Usage

API Usage

import { gen } from '@lexmin0412/api-code-generator'
import path from 'path'

const rootDir = path.resolve(__dirname)
const requestInstancePath = path.resolve(__dirname, 'src', 'request.ts')

gen({
	rootDir,
	requestInstancePath,
	excludeDirs: ['assets'],
	transformConfig: {
		var2TypeMap: {
			string: ['id', 'parent_id'],
			'string[]': ['ids'],
		},
	},
})

CLI Usage

npx acg ./

Options

interface GenOptions {
	/**
	 * root dir for excuting tasks to generate files
	 */
	rootDir: string
	/**
	 * path for your custom request instance
	 */
	requestInstancePath: string
	/**
	 * excluded paths when scanning *.swagger.json files
	 */
	excludeDirs: string[]
	/**
	 * type transforming configuration
	 */
	transformConfig: {
		/**
		 * variable type transforming map
		 */
		var2TypeMap: {
			[key: string]: string[]
		}
		/**
		 * variable list that should be transformed to string
		 */
		toStringVars?: string[]
	}
}