chore: rename allowedPaths and allowedTags (#113)

* chore: rename  allowedTags => includeTags, allowedPaths => includePaths

Author: remember-5

.changeset/rich-trees-applaud.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': minor
+---
+
+rename allowedPath and allowedTags

CHANGELOG.md

@@ -52,7 +52,7 @@
 
 ### Patch Changes
 
-- [`430c164`](https://github.com/openapi-ui/openapi-ts-request/commit/430c1648fa0cb1737ed83f762bff434678488c50) Thanks [@rookie-luochao](https://github.com/rookie-luochao)! - fix: fix $ref includes encode character causing allowedTags function error
+- [`430c164`](https://github.com/openapi-ui/openapi-ts-request/commit/430c1648fa0cb1737ed83f762bff434678488c50) Thanks [@rookie-luochao](https://github.com/rookie-luochao)! - fix: fix $ref includes encode character causing includeTags function error
 
 ## 0.8.2
 

README-en_US.md

@@ -137,7 +137,12 @@ $ openapi --help
     -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", default is "axios"
-    --allowedTags <string[]>           generate code from allowed tags
+    --enableLogging <boolean>          open the log
+    --priorityRule <string>            priority rule, include/exclude/both
+    --includeTags <string|RegExp>[]    generate code from include tags
+    --includePaths <string|RegExp>[]   generate code from include paths
+    --excludeTags <string|RegExp>[]    generate code from exclude tags
+    --excludePaths <string|RegExp>[]   generate code from exclude paths
     --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
                                       string]: unknown }")
     --requestImportStatement <string>  custom request import statement, for example: "const request =
@@ -168,7 +173,12 @@ openapi -i ./spec.json -o ./apis
 | schemaPath | yes | string | - | Swagger2/OpenAPI3 URL |
 | serversPath | no | string | './src/apis' | the folder path for the generated results |
 | requestLibPath | no | string | 'axios' | custom request lib path, for example: '@/request', 'node-fetch' |
-| allowedTags | no | string[] | - | generate code from allowed tags |
+| enableLogging | no | boolean | false | open the log |
+| priorityRule | no | string | 'include' | priority rule, include/exclude/both |
+| includeTags | no | (string\|RegExp)[] | - | generate code from include tags, priorityRule=include required |
+| includePaths | no | (string\|RegExp)[] | - | generate code from include paths |
+| excludeTags | no | (string\|RegExp)[] | - | generate code from exclude tags |
+| excludePaths | no | (string\|RegExp)[] | - | generate code from exclude paths |
 | requestOptionsType | no | string | '{ [key: string]: unknown }' | custom request method options parameter type |
 | requestImportStatement | no | string | - | custom request import statement, for example: "const request = require('@/request')" |
 | apiPrefix | no | string | - | custom the prefix of the api path, for example: 'api'(variable), "'api'"(string) |

README.md

@@ -137,7 +137,12 @@ $ openapi --help
     -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", default is "axios"
-    --allowedTags <string[]>           generate code from allowed tags
+    --enableLogging <boolean>          open the log
+    --priorityRule <string>            priority rule, include/exclude/both
+    --includeTags <string|RegExp>[]    generate code from include tags
+    --includePaths <string|RegExp>[]   generate code from include paths
+    --excludeTags <string|RegExp>[]    generate code from exclude tags
+    --excludePaths <string|RegExp>[]   generate code from exclude paths
     --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
                                       string]: unknown }")
     --requestImportStatement <string>  custom request import statement, for example: "const request =
@@ -169,9 +174,9 @@ openapi --i ./spec.json --o ./apis
 | serversPath | 否 | string | './src/apis' | 生成结果的文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
 | enableLogging | 否 | boolean | false | 是否开启日志 |
-| priorityRule | 否 | string | 'exclude' | 模式规则，可选allowed/exclude/include |
-| allowedTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 生成代码 |
-| allowedPaths | 否 | (string\|RegExp)[] | - | 根据指定的 paths 生成代码 |
+| priorityRule | 否 | string | 'include' | 模式规则，可选include/exclude/both |
+| includeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 生成代码, priorityRule=include则必填 |
+| includePaths | 否 | (string\|RegExp)[] | - | 根据指定的 paths 生成代码 |
 | excludeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 不生成代码 |
 | excludePaths | 否 | (string\|RegExp)[] | - | 根据指定的 paths 不生成代码 |
 | requestOptionsType | 否 | string | '{ [key: string]: unknown }' | 自定义请求方法 options 参数类型 |

pnpm-lock.yaml

@@ -18,7 +18,7 @@ const params = program
     '--requestLibPath <string>',
     'custom request lib path, for example: "@/request", "node-fetch", default is "axios"'
   )
-  .option('--allowedTags <string[]>', 'generate results from allowed tags')
+  .option('--includeTags <string[]>', 'generate results from include tags')
   .option(
     '--requestOptionsType <string>',
     'custom request method options parameter type (default: "{ [key: string]: unknown }")'
@@ -77,7 +77,7 @@ async function run() {
       schemaPath: input,
       serversPath: output,
       requestLibPath: params.requestLibPath as string,
-      allowedTags: params.allowedTags as string[],
+      includeTags: params.includeTags as string[],
       requestOptionsType: params.requestOptionsType as string,
       apiPrefix: params.apiPrefix as string,
       isDisplayTypeLabel:

src/bin/openapi.ts

@@ -107,20 +107,20 @@ export default class ServiceGenerator {
     };
     this.generateInfoLog();
 
-    const allowedPaths = this.config?.allowedPaths || [];
-    const allowedTags = this.config?.allowedTags || [];
+    const includePaths = this.config?.includePaths || [];
+    const includeTags = this.config?.includeTags || [];
     const excludePaths = this.config?.excludePaths || [];
     const excludeTags = this.config?.excludeTags || [];
 
     const priorityRule: PriorityRule =
       PriorityRule[config.priorityRule as keyof typeof PriorityRule];
 
     if (
-      priorityRule === PriorityRule.allowed &&
-      isEmpty(this.config?.allowedTags) &&
-      isEmpty(this.config?.allowedPaths)
+      priorityRule === PriorityRule.include &&
+      isEmpty(this.config?.includeTags) &&
+      isEmpty(this.config?.includePaths)
     ) {
-      this.log('priorityRule allowed need allowedTags or allowedPaths');
+      this.log('priorityRule include need includeTags or includePaths');
     }
     const hookCustomFileNames =
       this.config.hook?.customFileNames || getDefaultFileTag;
@@ -136,16 +136,16 @@ export default class ServiceGenerator {
     for (const pathKey in this.openAPIData.paths) {
       // 这里判断paths
       switch (priorityRule) {
-        case PriorityRule.allowed: {
-          // allowedPaths and allowedTags is empty 没有任何allowed配置,直接跳过这个数组的所有元素
-          if (isEmpty(allowedTags) && isEmpty(allowedPaths)) {
-            this.log('priorityRule allowed need allowedTags or allowedPaths');
+        case PriorityRule.include: {
+          // includePaths and includeTags is empty 没有任何include配置,直接跳过这个数组的所有元素
+          if (isEmpty(includeTags) && isEmpty(includePaths)) {
+            this.log('priorityRule include need includeTags or includePaths');
             continue;
           }
 
           if (
-            !isEmpty(allowedPaths) &&
-            !allowedPaths.some((pathRule) =>
+            !isEmpty(includePaths) &&
+            !includePaths.some((pathRule) =>
               typeof pathRule === 'string'
                 ? minimatch(pathKey, pathRule)
                 : pathRule.test(pathKey)
@@ -167,16 +167,16 @@ export default class ServiceGenerator {
           }
           break;
         }
-        case PriorityRule.include: {
-          // allowedPaths is empty 没有配置,直接跳过
-          if (isEmpty(allowedTags) && isEmpty(allowedPaths)) {
-            this.log('priorityRule include need allowedTags or allowedPaths');
+        case PriorityRule.both: {
+          // includePaths is empty 没有配置,直接跳过
+          if (isEmpty(includeTags) && isEmpty(includePaths)) {
+            this.log('priorityRule include need includeTags or includePaths');
             continue;
           }
 
-          const inAllowedPaths =
-            !isEmpty(allowedPaths) &&
-            !allowedPaths.some((path) =>
+          const inIncludePaths =
+            !isEmpty(includePaths) &&
+            !includePaths.some((path) =>
               typeof path === 'string'
                 ? minimatch(pathKey, path)
                 : path.test(pathKey)
@@ -189,14 +189,14 @@ export default class ServiceGenerator {
                 : path.test(pathKey)
             );
 
-          if (inAllowedPaths || inExcludePaths) {
+          if (inIncludePaths || inExcludePaths) {
             continue;
           }
           break;
         }
         default:
           throw new Error(
-            'priorityRule must be "allowed" or "exclude" or "include"'
+            'priorityRule must be "include" or "exclude" or "include"'
           );
       }
 
@@ -219,19 +219,19 @@ export default class ServiceGenerator {
         tags.forEach((tag) => {
           const tagLowerCase = tag.toLowerCase();
 
-          if (priorityRule === PriorityRule.allowed) {
-            // allowedTags 为空, 不会匹配任何path,故跳过; allowedTags 和 allowedPaths 同时为空则没意义,故跳过;
+          if (priorityRule === PriorityRule.include) {
+            // includeTags 为空, 不会匹配任何path,故跳过; includeTags 和 includePaths 同时为空则没意义,故跳过;
             if (
-              isEmpty(allowedTags) ||
-              (isEmpty(allowedTags) && isEmpty(allowedPaths))
+              isEmpty(includeTags) ||
+              (isEmpty(includeTags) && isEmpty(includePaths))
             ) {
-              this.log('priorityRule include need allowedTags or allowedPaths');
+              this.log('priorityRule include need includeTags or includePaths');
               return;
             }
 
             if (
-              !isEmpty(allowedTags) &&
-              !allowedTags.some((tagRule) =>
+              !isEmpty(includeTags) &&
+              !includeTags.some((tagRule) =>
                 typeof tagRule === 'string'
                   ? minimatch(tagLowerCase, tagRule)
                   : tagRule.test(tagLowerCase)
@@ -253,16 +253,16 @@ export default class ServiceGenerator {
             }
           }
 
-          if (priorityRule === PriorityRule.include) {
-            // allowedTags is empty 没有配置,直接跳过
-            if (isEmpty(allowedTags)) {
-              this.log('priorityRule include need allowedTags or allowedPaths');
+          if (priorityRule === PriorityRule.both) {
+            // includeTags is empty 没有配置,直接跳过
+            if (isEmpty(includeTags)) {
+              this.log('priorityRule include need includeTags or includePaths');
               return;
             }
 
-            const inAllowedTags =
-              !isEmpty(allowedTags) &&
-              !allowedTags.some((tagRule) =>
+            const inincludeTags =
+              !isEmpty(includeTags) &&
+              !includeTags.some((tagRule) =>
                 typeof tagRule === 'string'
                   ? minimatch(tagLowerCase, tagRule)
                   : tagRule.test(tagLowerCase)
@@ -274,7 +274,7 @@ export default class ServiceGenerator {
                   ? minimatch(tagLowerCase, tagRule)
                   : tagRule.test(tagLowerCase)
               );
-            if (inAllowedTags || inExcludeTags) {
+            if (inincludeTags || inExcludeTags) {
               return;
             }
           }
@@ -451,13 +451,13 @@ export default class ServiceGenerator {
 
         // 筛选出 pathItem 包含的 $ref 对应的schema
         if (
-          !isEmpty(this.config?.allowedTags) &&
+          !isEmpty(this.config?.includeTags) &&
           !isEmpty(operationObject.tags)
         ) {
           if (
             !isEmpty(
               intersection(
-                this.config.allowedTags,
+                this.config.includeTags,
                 map(operationObject.tags, (tag) => tag.toLowerCase())
               )
             )
@@ -548,7 +548,7 @@ export default class ServiceGenerator {
 
       // 判断哪些 schema 需要添加进 type, schemas 渲染数组
       if (
-        isEmpty(this.config.allowedTags) ||
+        isEmpty(this.config.includeTags) ||
         (schema as ICustomSchemaObject)?.isAllowed
       ) {
         const isEnum = result.isEnum as boolean;
@@ -1240,16 +1240,16 @@ export default class ServiceGenerator {
   private generateInfoLog(): void {
     this.log(`priorityRule: ${this.config?.priorityRule}`);
 
-    if (this.config?.allowedTags) {
-      this.log(`allowedTags: ${this.config?.allowedTags.join(', ')}`);
+    if (this.config?.includeTags) {
+      this.log(`includeTags: ${this.config?.includeTags.join(', ')}`);
     }
 
     if (this.config?.excludeTags) {
       this.log(`excludeTags: ${this.config?.excludeTags.join(', ')}`);
     }
 
-    if (this.config?.allowedPaths) {
-      this.log(`allowedPaths: ${this.config?.allowedPaths.join(', ')}`);
+    if (this.config?.includePaths) {
+      this.log(`includePaths: ${this.config?.includePaths.join(', ')}`);
     }
 
     if (this.config?.excludePaths) {

src/generator/serviceGenarator.ts

@@ -40,17 +40,17 @@ export type GenerateServiceProps = {
   enableLogging?: boolean;
   /**
   /**
-   * 优先规则, allowed(只允许allowed列表) | exclude(只排除exclude列表) | include(允许allowed列表，排除exclude列表)
+   * 优先规则, include(只允许include列表) | exclude(只排除exclude列表) | include(允许include列表，排除exclude列表)
    */
   priorityRule?: string;
   /**
    * 只解析归属于 tags 集合的api 和 schema
    */
-  allowedTags?: (string | RegExp)[];
+  includeTags?: (string | RegExp)[];
   /**
    * 只解析归属于 paths 集合的api
    */
-  allowedPaths?: (string | RegExp)[];
+  includePaths?: (string | RegExp)[];
   /**
    * 不解析归属于 tags 集合的api 和 schema
    */
@@ -199,7 +199,7 @@ export async function generateService({
   requestLibPath,
   schemaPath,
   mockFolder,
-  allowedTags,
+  includeTags,
   excludeTags,
   authorization,
   isTranslateToEnglishTag,
@@ -235,8 +235,8 @@ export async function generateService({
       isDisplayTypeLabel: false,
       isGenJsonSchemas: false,
       isOnlyGenTypeScriptType: false,
-      allowedTags: allowedTags
-        ? map(allowedTags, (item) =>
+      includeTags: includeTags
+        ? map(includeTags, (item) =>
             typeof item === 'string' ? item.toLowerCase() : item
           )
         : [],
@@ -246,7 +246,7 @@ export async function generateService({
           )
         : null,
       enableLogging: false,
-      priorityRule: 'allowed',
+      priorityRule: 'include',
       ...rest,
     },
     openAPI

src/index.ts

@@ -106,15 +106,15 @@ export enum SchemaObjectType {
 }
 
 export enum PriorityRule {
-  allowed = 'allowed',
-  exclude = 'exclude',
   include = 'include',
+  exclude = 'exclude',
+  both = 'both',
 }
 
 export type GenerateRegExp = {
-  allowedTags: (string | RegExp)[];
+  includeTags: (string | RegExp)[];
   excludeTags: (string | RegExp)[];
-  allowedPaths: (string | RegExp)[];
+  includePaths: (string | RegExp)[];
   excludePaths: (string | RegExp)[];
 };