openapi-ts-request 0.4.4 → 0.4.6

package/README.md

@@ -29,18 +29,22 @@ pnpm i openapi-ts-request -D
 
 ### CosmiConfig
 
-在项目根目录新建 ```openapi-ts.config.ts``` 
-> 配置文件还支持 ***.openapi-ts.ts***, ***openapi-ts.config.cjs*** 等格式，参考 [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#cosmiconfig)
+在项目根目录新建 ```openapi-ts-request.config.ts``` 
+> 配置文件还支持 ***.openapi-ts-request.ts***, ***openapi-ts-request.config.cjs*** 等格式，参考 [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#cosmiconfig)
 
 ```ts
+import type { GenerateServiceProps } from 'openapi-ts-request'
+
 export default {
   schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
-}
+} as GenerateServiceProps
 ```
 
 支持传入数组配置进行生成
 
 ```ts
+import type { GenerateServiceProps } from 'openapi-ts-request'
+
 export default [
   {
     schemaPath: 'http://app.swagger.io/v2/swagger.json',
@@ -50,7 +54,7 @@ export default [
     schemaPath: 'http://auth.swagger.io/v2/swagger.json',
     serversPath: './src/apis/auth',
   }
-]
+] as GenerateServiceProps[]
 ```
 
 在 ```package.json``` 的 ```script``` 中添加命令: ```"openapi": "openapi-ts",```
@@ -63,7 +67,7 @@ npm run openapi
 
 ### JS
 
-任意目录 ```xxx/xxx``` 新建 ```openapi-ts.config.js```
+任意目录 ```xxx/xxx``` 新建 ```openapi-ts-request.config.js```
 
 ```ts
 const { generateService } = require('openapi-ts-request')
@@ -74,7 +78,7 @@ generateService({
 })
 ```
 
-在 ```package.json``` 的 ```script``` 中添加命令: ```"openapi": "node xxx/xxx/openapi-ts.config.js"```
+在 ```package.json``` 的 ```script``` 中添加命令: ```"openapi": "node xxx/xxx/openapi-ts-request.config.js"```
 
 生成结果：
 
@@ -84,7 +88,7 @@ npm run openapi
 
 ### TS
 
-任意目录 ```xxx/xxx``` 新建 ```openapi-ts.config.ts```
+任意目录 ```xxx/xxx``` 新建 ```openapi-ts-request.config.ts```
 
 ```ts
 const { generateService } = require('openapi-ts-request')
@@ -95,7 +99,7 @@ generateService({
 })
 ```
 
-在 ```package.json``` 的 ```script``` 中添加命令: ```"openapi": "ts-node xxx/xxx/openapi-ts.config.ts",```
+在 ```package.json``` 的 ```script``` 中添加命令: ```"openapi": "ts-node xxx/xxx/openapi-ts-request.config.ts",```
 
 生成结果：
 
@@ -129,21 +133,20 @@ $ openapi --help
   Options:
     -V, --version                      output the version number
     -i, --input <string>               OpenAPI specification, can be a path, url (required)
-    -o, --output <string>              Output directory (required)
+    -o, --output <string>              output directory (required)
     --requestLibPath <string>          custom request lib path, for example: "@/request", "node-fetch"
-    --allowedTags <string[]>           Generate results from allowed tags
-    --requestOptionsType <string>      Custom request method options parameter type (default: "{ [key:
+    --allowedTags <string[]>           generate results from allowed tags
+    --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
                                       string]: unknown }")
     --requestImportStatement <string>  custom request import statement, for example: "const request =
-                                      require(`@/request`)"
-    --apiPrefix <string>               Custom the prefix of the api path, for example: "api"(variable),
-                                      `"api"`(string)
-    --isDisplayTypeLabel <boolean>     Generate label matching type field (default: false) (default: false)
-    --isGenJsonSchemas <boolean>       Generate JSON Schemas (default: false) (default: false)
-    --mockFolder <string>              Mock file path, (default: "./mocks")
-    --nullable <boolean>               null instead of optional (default: false) (default: false)
-    --isCamelCase <boolean>            CamelCase naming of controller files and request client (default: true)
-                                      (default: true)
+                                      require('@/request')"
+    --apiPrefix <string>               custom the prefix of the api path, for example: "api"(variable),
+                                      "'api'"(string)
+    --isDisplayTypeLabel <boolean>     generate label matching type field (default: false)
+    --isGenJsonSchemas <boolean>       generate JSON Schemas (default: false)
+    --mockFolder <string>              mock file path (default: "./mocks")
+    --nullable <boolean>               null instead of optional (default: false)
+    --isCamelCase <boolean>            camelCase naming of controller files and request client (default: true)
     -h, --help                         display help for command
 ```
 

package/dist/bin/cli.js

@@ -5,8 +5,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const cosmiconfig_1 = require("cosmiconfig");
+const cosmiconfig_typescript_loader_1 = require("cosmiconfig-typescript-loader");
 const index_1 = require("../index");
-const explorerSync = (0, cosmiconfig_1.cosmiconfigSync)('openapi-ts-request');
+const explorerSync = (0, cosmiconfig_1.cosmiconfigSync)('openapi-ts-request', {
+    loaders: {
+        '.ts': (0, cosmiconfig_typescript_loader_1.TypeScriptLoader)(),
+    },
+});
 const config = (_a = explorerSync.search()) === null || _a === void 0 ? void 0 : _a.config;
 function run() {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {

package/dist/bin/openapi.js

@@ -11,17 +11,17 @@ const params = commander_1.program
     .usage('[options]')
     .version(pkg.version)
     .requiredOption('-i, --input <string>', 'OpenAPI specification, can be a path, url (required)')
-    .requiredOption('-o, --output <string>', 'Output directory (required)')
+    .requiredOption('-o, --output <string>', 'output directory (required)')
     .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch"')
-    .option('--allowedTags <string[]>', 'Generate results from allowed tags')
-    .option('--requestOptionsType <string>', 'Custom request method options parameter type (default: "{ [key: string]: unknown }")')
-    .option('--requestImportStatement <string>', 'custom request import statement, for example: "const request = require(`@/request`)"')
-    .option('--apiPrefix <string>', 'Custom the prefix of the api path, for example: "api"(variable), `"api"`(string)')
-    .option('--isDisplayTypeLabel <boolean>', 'Generate label matching type field (default: false)', false)
-    .option('--isGenJsonSchemas <boolean>', 'Generate JSON Schemas (default: false)', false)
-    .option('--mockFolder <string>', 'Mock file path, (default: "./mocks")')
-    .option('--nullable <boolean>', 'null instead of optional (default: false)', false)
-    .option('--isCamelCase <boolean>', 'CamelCase naming of controller files and request client (default: true)', true)
+    .option('--allowedTags <string[]>', 'generate results from allowed tags')
+    .option('--requestOptionsType <string>', 'custom request method options parameter type (default: "{ [key: string]: unknown }")')
+    .option('--requestImportStatement <string>', `custom request import statement, for example: "const request = require('@/request')"`)
+    .option('--apiPrefix <string>', `custom the prefix of the api path, for example: "api"(variable), "'api'"(string)`)
+    .option('--isDisplayTypeLabel <boolean>', 'generate label matching type field', false)
+    .option('--isGenJsonSchemas <boolean>', 'generate JSON Schemas', false)
+    .option('--mockFolder <string>', 'Mock file path (default: "./mocks")')
+    .option('--nullable <boolean>', 'null instead of optional', false)
+    .option('--isCamelCase <boolean>', 'camelCase naming of controller files and request client', true)
     .parse(process.argv)
     .opts();
 function getPath(path) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "repository": {
     "type": "git",
@@ -26,6 +26,7 @@
     "chalk": "^4.1.2",
     "commander": "^12.1.0",
     "cosmiconfig": "^9.0.0",
+    "cosmiconfig-typescript-loader": "^5.0.0",
     "glob": "^10.4.2",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.17",