chore: merge to release branch (#378)

* feat: 枚举类型支持空格

* chore: add changeset

* feat: priorityRule 为 both 和 include 的时候都设置includeTags, includePaths 默认值为 [/.*/g] (#376)

* feat: priorityRule 为 both 和 include 的时候都设置includeTags

* fix: 添加includePaths 默认值，解决没有设置includePaths时没有类型生成问题

* chore: generate changeset

---------

Co-authored-by: AdoKevin <kevinlaw1024@gmail.com>

Author: rookie-luochao

.changeset/plain-yaks-warn.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+priorityRule 为 both 和 include 的时候都设置includeTags, includePaths 的默认值为[/.*/g]

.changeset/tame-nails-clean.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+feat: 枚举类型支持空格

src/generator/serviceGenarator.ts

@@ -1204,7 +1204,7 @@ export default class ServiceGenerator {
     } else if (isAllNumeric(enumArray)) {
       enumStr = `{${map(enumArray, (value) => `"STRING_NUMBER_${value}"="${value}"`).join(',')}}`;
     } else {
-      enumStr = `{${map(enumArray, (value) => `${value}="${value}"`).join(',')}}`;
+      enumStr = `{${map(enumArray, (value) => `"${value}"="${value}"`).join(',')}}`;
     }
 
     // 翻译枚举
@@ -1243,7 +1243,7 @@ export default class ServiceGenerator {
       } else if (isAllNumeric(enumArray)) {
         enumLabelTypeStr = `{${map(enumArray, (value) => `"${value}":"STRING_NUMBER_${value}"`).join(',')}}`;
       } else {
-        enumLabelTypeStr = `{${map(enumArray, (value) => `${value}:"${value}"`).join(',')}}`;
+        enumLabelTypeStr = `{${map(enumArray, (value) => `"${value}":"${value}"`).join(',')}}`;
       }
     }
 

src/index.ts

@@ -255,6 +255,8 @@ export async function generateService({
   mockFolder,
   includeTags,
   excludeTags,
+  includePaths,
+  excludePaths,
   authorization,
   isTranslateToEnglishTag,
   priorityRule = PriorityRule.include,
@@ -300,14 +302,28 @@ export async function generateService({
         ? map(includeTags, (item) =>
             typeof item === 'string' ? item.toLowerCase() : item
           )
-        : priorityRule === PriorityRule.include
+        : priorityRule === PriorityRule.include ||
+            priorityRule === PriorityRule.both
+          ? [/.*/g]
+          : null,
+      includePaths: includePaths
+        ? map(includePaths, (item) =>
+            typeof item === 'string' ? item.toLowerCase() : item
+          )
+        : priorityRule === PriorityRule.include ||
+            priorityRule === PriorityRule.both
           ? [/.*/g]
           : null,
       excludeTags: excludeTags
         ? map(excludeTags, (item) =>
             typeof item === 'string' ? item.toLowerCase() : item
           )
         : null,
+      excludePaths: excludePaths
+        ? map(excludePaths, (item) =>
+            typeof item === 'string' ? item.toLowerCase() : item
+          )
+        : null,
       requestOptionsType: '{[key: string]: unknown}',
       namespace: 'API',
       isGenReactQuery: false,

test/example-files/openapi-complex-enum-convert.json

@@ -0,0 +1,71 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Hello World API",
+    "version": "1.0.0",
+    "description": "A simple API that returns a student object."
+  },
+  "servers": [
+    {
+      "url": "http://localhost:3000",
+      "description": "Local server"
+    }
+  ],
+  "tags": [
+    {
+      "name": "student",
+      "description": "Everything about Student"
+    }
+  ],
+  "paths": {
+    "/hello": {
+      "get": {
+        "tags": ["student"],
+        "summary": "Returns a student object",
+        "responses": {
+          "200": {
+            "description": "A student object",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Student"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Major": {
+        "type": "string",
+        "enum": ["COMPUTER SCIENCE", "MATHEMATICS", "PHYSICS", "LITERATURE"],
+        "example": "COMPUTER SCIENCE"
+      },
+      "Student": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "example": "张三"
+          },
+          "age": {
+            "type": "integer",
+            "example": 20
+          },
+          "gender": {
+            "type": "string",
+            "enum": ["MALE", "FEMALE", "OTHER"],
+            "example": "MALE"
+          },
+          "major": {
+            "$ref": "#/components/schemas/Major"
+          }
+        },
+        "required": ["name", "age", "gender", "major"]
+      }
+    }
+  }
+}

test/test.js

@@ -75,16 +75,15 @@ const gen = async () => {
             return `
 export async function ${api.functionName}(${api.params && api.hasParams ? `params: ${ctx.namespace}.${api.typeName}` : ''}) {
   return request.get('${api.path}', { params })
-}`
-          }
-          else {
+}`;
+          } else {
             return `
 export async function ${api.functionName}(${api.body ? `data: ${api.body.type}` : ''}) {
   return request.post('${api.path}', data)
-}`
+}`;
           }
-        }
-      }
+        },
+      },
     },
   });
 
@@ -138,6 +137,14 @@ export async function ${api.functionName}(${api.body ? `data: ${api.body.type}`
     includeTags: ['pet'],
   });
 
+  // 测试 "COMPUTER SCIENCE" 这一类的枚举值在生成的类型中不报错
+  await openAPI.generateService({
+    schemaPath: `${__dirname}/example-files/openapi-complex-enum-convert.json`,
+    serversPath: './apis/complex-enum-convert',
+    includePaths: [/.*/g],
+    includeTags: [/.*/g],
+  });
+
   // 测试生成 JSON Schemas
   await openAPI.generateService({
     schemaPath: `${__dirname}/example-files/openapi-display-enum-label.json`,