openapi-ts-request 0.3.4 → 0.4.0

package/README.md

@@ -12,6 +12,7 @@
 
 * 支持 Swagger2.0/OpenAPI 3.0,3.1 定义
 * 生成 TS 类型, 请求客户端, 请求模拟服务, 枚举, 类型字段翻译, JSON Schemas
+* 支持通过 npx、CLI、Nodejs 的方式使用
 * 支持自定义请求工具函数, 支持 Fetch、Axios、UniApp-Request、Node.js、XHR 客户端
 * 支持通过 tags 过滤生成结果
 * 支持 JSON 定义文件
@@ -100,6 +101,50 @@ generateService({
 npm run openapi
 ```
 
+### NPX
+
+```
+npx openapi-ts-request openapi -i ./openapi.json -o ./apis
+```
+
+### CLI
+
+```
+npm i openapi-ts-request -g
+```
+
+```
+$ openapi --help
+
+  Usage: openapi [options]
+
+  Options:
+    -V, --version                      output the version number
+    -i, --input <string>               OpenAPI specification, can be a path, url (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:
+                                      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)
+    -h, --help                         display help for command
+```
+
+生成结果：
+
+```bash
+openapi --i ./spec.json --o ./apis
+```
+
 ## 参数
 
 | 属性                    | 必填  |   类型    | 默认值        | 说明  |

package/dist/{cli.js → bin/cli.js}

@@ -5,7 +5,7 @@ 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 index_1 = require("./index");
+const index_1 = require("../index");
 const explorerSync = (0, cosmiconfig_1.cosmiconfigSync)('openapi-ts-request');
 const config = (_a = explorerSync.search()) === null || _a === void 0 ? void 0 : _a.config;
 function run() {

package/dist/bin/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/index.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const commander_1 = require("commander");
+const path_1 = require("path");
+const pkg = tslib_1.__importStar(require("../../package.json"));
+const index_1 = require("../index");
+const params = commander_1.program
+    .name('openapi')
+    .usage('[options]')
+    .version(pkg.version)
+    .requiredOption('-i, --input <string>', 'OpenAPI specification, can be a path, url (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)
+    .parse(process.argv)
+    .opts();
+function getPath(path) {
+    const cwd = process.cwd();
+    return (0, path_1.join)(cwd, path);
+}
+function run() {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        try {
+            const input = getPath(params.input);
+            const output = getPath(params.output);
+            yield (0, index_1.generateService)({
+                schemaPath: input,
+                serversPath: output,
+                requestLibPath: params.requestLibPath,
+                allowedTags: params.allowedTags,
+                requestOptionsType: params.requestOptionsType,
+                apiPrefix: params.apiPrefix,
+                isDisplayTypeLabel: JSON.parse(params.isDisplayTypeLabel) === true,
+                isGenJsonSchemas: JSON.parse(params.isGenJsonSchemas) === true,
+                mockFolder: params.mockFolder,
+                nullable: JSON.parse(params.nullable) === true,
+                isCamelCase: JSON.parse(params.isCamelCase) === true,
+            });
+            process.exit(0);
+        }
+        catch (error) {
+            console.error('this is error: ', error);
+            process.exit(1);
+        }
+    });
+}
+void run();

package/dist/generator/file.js

@@ -10,7 +10,7 @@ const prettierFile = (content) => {
     let result = content;
     let hasError = false;
     try {
-        result = (0, sync_1.format)(content, Object.assign(Object.assign({}, prettier_config_cjs_1.default), { parser: 'typescript', importOrderSeparation: false }));
+        result = (0, sync_1.format)(content, Object.assign(Object.assign({}, prettier_config_cjs_1.default), { parser: 'typescript', plugins: [] }));
     }
     catch (error) {
         hasError = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "repository": {
     "type": "git",
@@ -11,7 +11,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
-    "openapi-ts-request": "dist/cli.js"
+    "openapi": "dist/bin/index.js",
+    "openapi-ts-request": "dist/bin/cli.js"
   },
   "files": [
     "dist",
@@ -23,6 +24,7 @@
     "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "axios": "^1.7.2",
     "chalk": "^4.1.2",
+    "commander": "^12.1.0",
     "cosmiconfig": "^9.0.0",
     "glob": "^10.4.2",
     "lodash": "^4.17.21",

package/templates/serviceIndex.njk

@@ -4,7 +4,6 @@ import * as {{ namespace }} from './{{ interfaceFileName }}';
 {%- if isGenJsonSchemas %}
 import * as schemas from './{{ schemaFileName }}';
 {%- endif %}
-
 {% for api in list -%}
 import * as {{ api.controllerName }} from './{{ api.fileName }}';
 {% endfor -%}