Merge pull request #59 from long-woo/dev

v1.6.1

README.md

@@ -9,24 +9,28 @@ STC(Swagger Transform Code) 是一个 Swagger 文档转换成代码文件的工
 ![Publish to release](https://github.com/long-woo/stc/actions/workflows/deno-build.yml/badge.svg)
 [![Publish Package to npmjs](https://github.com/long-woo/stc/actions/workflows/npm.yml/badge.svg)](https://github.com/long-woo/stc/actions/workflows/npm.yml)
 
+<div align="center">
+  <img src="resources/20240422-151653.gif" alt="stc" />
+</div>
+
 feature:
 特性：
 
-- Support for Swagger 2, 3 and Apifox.
+- 🐹 Support for Swagger 2, 3 and Apifox.
 
-  支持 Swagger 2、3 和 Apifox。
+  🐹 支持 Swagger 2、3 和 Apifox。
 
-- Support Axios, Wechat request library。
+- 🌐 Support Axios, Wechat request library。
 
-  支持 Axios、Wechat 请求库。
+  🌐 支持 Axios、Wechat 请求库。
 
-- Support plug-in development.
+- 💡 Support plug-in development.
 
-  支持插件开发。
+  💡 支持插件开发。
 
-- Built-in transformation languages:
+- 🐣 Built-in transformation languages:
 
-  内置转换语言：
+  🐣 内置转换语言：
 
   - TypeScript, almost equivalent to handwriting.
 
@@ -36,10 +40,12 @@ feature:
 
     JavaScript，由 TypeScript 转换而来。
 
-  - ...
+  - 🚧 ...
 
 ## Quick start 快速开始
 
+### Download executable files 下载可执行文件
+
 [download](https://github.com/long-woo/stc/releases) by system：
 
 按系统[下载](https://github.com/long-woo/stc/releases)：
@@ -55,6 +61,24 @@ feature:
 - stc-linux：Linux
 - stc-win.exe: Windows
 
+### NPM
+
+1.安装 `@loogwoo/stc` npm 包
+
+```sh
+pnpm add @loongwoo/stc -D
+```
+
+2.打开项目 `package.json` 文件，在 `scripts` 添加如下命令：
+
+```json
+{
+  "scripts": {
+    "api": "stc --url=http://127.0.0.1:4523/export/openapi/2?version=3.1"
+  }
+}
+```
+
 ### Use 使用
 
 ⚠️ Note: deno will not parse the `~` character as the user's home directory.
@@ -71,40 +95,51 @@ stc --url=https://petstore3.swagger.io/api/v3/openapi.json --outDir=out
 
 ### 已有项目
 
-#### axios
+假设一个项目目录为：
 
-1.找到 `outDir` 的目录，复制 `shared > webClientBase` 文件到该目录。
+```
+.
+├── src
+│   └── apis # 将 shared 目录复制到这里
+│       └── shared
+│       └── xxx.ts # 其他文件
+
+```
 
-2.打开 `shared > axios > fetch` 文件，复制 `request` 方法，添加到你封装的 `axios` 模块中。没有封装的话，可以复制整个 `fetch` 文件。
+#### Axios
+
+1.找到 `outDir` 的目录，复制 `shared` 整个目录到你封装的 `axios` 模块的目录下。
+
+2.打开 `shared > axios > index.ts` 文件，复制 `request` 方法，添加到你封装的 `axios` 模块中。若没有封装的话，复制 `index.ts` 文件为一个新文件，以免修改被覆盖的问题。
 
 3.以 `Vue` 为例，在 `main.ts` 文件中添加以下代码：
 
 ```ts
-import webClient from './apis/shared/axios/fetch'
+import { createApiClient } from './apis/shared/fetchRuntime';
 
-webClient.create({
+createApiClient({
   baseURL: 'https://api.xxx.com'
   // onError(msg) {
   //   // 处理错误信息
   // }
 })
 ```
 
-#### wechat
+#### Wechat
 
-1.找到 `outDir` 的目录，复制 `shared > webClientBase` 文件到该目录。
+1.找到 `outDir` 的目录，复制 `shared` 整个目录到你封装的 `wechat` 模块的目录下。
 
-2.打开 `shared > wechat > fetch` 文件，复制 `request` 方法，添加到你封装的 `axios` 模块中。没有封装的话，可以复制整个 `fetch` 文件。
+2.打开 `shared > wechat > index.ts` 文件，复制 `request` 方法，添加到你封装的 `wx.request` 代码文件中。若没有封装的话，复制 `index.ts` 文件为一个新文件，以免修改被覆盖的问题。
 
 3.在 `app.ts` 文件中添加以下代码:
 
 ```ts
-import webClient from './apis/shared/wechat/fetch';
+import { createApiClient } from './apis/shared/fetchRuntime';
 // import Notify from './miniprogram_npm/@vant/weapp/notify/notify';
 
 App<IAppOption>({
   onLaunch() {
-    webClient.create({
+    createApiClient({
       baseURL: 'https://api.xxx.com,
       onError(msg) {
         // Notify({ type: 'danger', message: msg, selector: '#v-notify'})
@@ -144,7 +179,7 @@ For convenience, STC can not only develop plugins in Deno, but also provides `@l
 
 ```ts
 // 引用模块
-import { start } from 'https://deno.land/x/stc@1.6.0/mod.ts'
+import { start } from 'https://deno.land/x/stc@1.6.1/mod.ts'
 
 // 定义插件
 const myPlugin: IPlugin = {
@@ -167,6 +202,9 @@ const myPlugin: IPlugin = {
       definition: defContent,
       action: actionContent // 这里的 actionContent 是 Map<string, string> 类型，key 是文件名称，value 是转换后的代码
     }
+  },
+  onEnd() {
+    console.log('end')
   }
 }
 
@@ -210,6 +248,9 @@ export const myPlugin: IPlugin = {
       definition: defContent,
       action: actionContent
     }
+  },
+  onEnd() {
+    console.log('end')
   }
 }
 ```

deno.json

@@ -1,11 +1,11 @@
 {
   "name": "@loongwoo/stc",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "exports": "./mod.ts",
   "tasks": {
     "dev": "deno run -A --watch=src src/main.ts --url 'https://petstore3.swagger.io/api/v3/openapi.json'",
     "serve": "deno run -A --watch=src src/service.ts",
-    "version": "echo '1.6.0' > release/version",
+    "version": "echo '1.6.1' > release/version",
     "build:npm": "deno run -A src/npm/index.ts",
     "build:mac": "deno compile -A --target x86_64-apple-darwin --output release/stc src/main.ts",
     "build:mac-m": "deno compile -A --target aarch64-apple-darwin --output release/stc-m src/main.ts",
@@ -16,16 +16,35 @@
     "esm:remove": "deno run -A https://esm.sh/v130 remove"
   },
   "lint": {
-    "include": ["src/", "test/"],
-    "exclude": ["**/out/**/*", "**/shared/**/*", "dist"]
+    "include": [
+      "src/",
+      "test/"
+    ],
+    "exclude": [
+      "**/out/**/*",
+      "**/shared/**/*",
+      "dist"
+    ]
   },
   "fmt": {
-    "include": ["src/", "test/"],
-    "exclude": ["out/**/*", "dist", "**/npm/package.json"]
+    "include": [
+      "src/",
+      "test/"
+    ],
+    "exclude": [
+      "out/**/*",
+      "dist",
+      "**/npm/package.json"
+    ]
   },
   "test": {
-    "include": ["test/"],
-    "exclude": ["out", "dist"]
+    "include": [
+      "test/"
+    ],
+    "exclude": [
+      "out",
+      "dist"
+    ]
   },
   "importMap": "import_map.json"
-}
+}

src/npm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loongwoo/stc",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "OpenApi/Swagger/Apifox document conversion tool.\nOpenAPI(Swagger)、Apifox 文档转换为接口文件。",
   "type": "module",
   "module": "esm/mod.js",
@@ -44,4 +44,4 @@
       }
     }
   }
-}
+}

src/plugins/typescript/shared/fetchRuntime.eta

@@ -11,7 +11,7 @@ import { request } from "./wechat/index.ts";
 import { createAxios, request } from "./axios/index.ts";
 <% } %>
 
-let apiClientInstance: ApiClientConfig;
+let apiClientInstance: ApiClientConfig = {};
 
 export const createApiClient = (
   config: Omit<ApiClientConfig, "url" | "signal" | "config">,

src/plugins/typescript/shared/index.ts

@@ -82,7 +82,7 @@ import { request } from "./wechat/index.ts";
 import { createAxios, request } from "./axios/index.ts";
 <% } %>
 
-let apiClientInstance: ApiClientConfig;
+let apiClientInstance: ApiClientConfig = {};
 
 export const createApiClient = (
   config: Omit<ApiClientConfig, "url" | "signal" | "config">,