Merge pull request #24 from povio/feature/exclude-path

Exclude path regex & Exclude redundant zod schemas

Author: monikaboz

README.md

@@ -36,7 +36,10 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
 
   --splitByTags                       Organize output into separate folders based on OpenAPI operation tags (default: true)
   --defaultTag                        (Requires `--splitByTags`) Default tag for shared code across multiple tags (default: 'Common')
-  --excludeTags                       (Requires `--splitByTags`) Comma-separated list of tags to exclude from generation
+
+  --excludeTags                       Comma-separated list of tags to exclude from generation
+  --excludePathRegex                  Exclude operations whose paths match the given regular expression
+  --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
 
   --tsNamespaces                      Wrap generated files in TypeScript namespaces (default: true)
   --importPath                        Module import style for generated files (default: 'ts'; options: 'ts' | 'relative' | 'absolute')
@@ -60,7 +63,10 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json --standalo
 
   --splitByTags                       Organize output into separate folders based on OpenAPI operation tags (default: true)
   --defaultTag                        (Requires `--splitByTags`) Default tag for shared code across multiple tags (default: 'Common')
-  --excludeTags                       (Requires `--splitByTags`) Comma-separated list of tags to exclude from generation
+
+  --excludeTags                       Comma-separated list of tags to exclude from generation
+  --excludePathRegex                  Exclude operations whose paths match the given regular expression
+  --excludeRedundantZodSchemas        Exclude any redundant Zod schemas (default: true)
 ```
 
 ## Development

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@povio/openapi-codegen-cli",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "main": "./dist/index.js",
   "bin": {
     "openapi-codegen": "./dist/sh.js"

src/commands/check.command.ts

@@ -1,3 +1,4 @@
+import { DEFAULT_GENERATE_OPTIONS } from "src/generators/const/options.const";
 import yargs from "yargs";
 import { logBanner, logVariable } from "../helpers/cli.helper";
 import { getVersion } from "../helpers/version.helper";
@@ -8,15 +9,25 @@ class CheckOptions implements CheckParams {
   @YargOption({ envAlias: "input", demandOption: true })
   input!: string;
 
-  @YargOption({ envAlias: "splitByTags", default: true, type: "boolean" })
+  @YargOption({ envAlias: "splitByTags", default: DEFAULT_GENERATE_OPTIONS.splitByTags, type: "boolean" })
   splitByTags!: boolean;
 
-  @YargOption({ envAlias: "defaultTag", default: "Common" })
+  @YargOption({ envAlias: "defaultTag", default: DEFAULT_GENERATE_OPTIONS.defaultTag })
   defaultTag!: string;
 
-  @YargOption({ envAlias: "excludeTags", default: "" })
+  @YargOption({ envAlias: "excludeTags", default: DEFAULT_GENERATE_OPTIONS.excludeTags.join(",") })
   excludeTags!: string;
 
+  @YargOption({ envAlias: "excludePathRegex", default: DEFAULT_GENERATE_OPTIONS.excludePathRegex })
+  excludePathRegex!: string;
+
+  @YargOption({
+    envAlias: "excludeRedundantZodSchemas",
+    default: DEFAULT_GENERATE_OPTIONS.excludeRedundantZodSchemas,
+    type: "boolean",
+  })
+  excludeRedundantZodSchemas!: boolean;
+
   @YargOption({ envAlias: "verbose", default: false, type: "boolean" })
   verbose!: boolean;
 }

src/commands/generate.command.ts

@@ -1,9 +1,9 @@
+import { DEFAULT_GENERATE_OPTIONS } from "src/generators/const/options.const";
 import yargs from "yargs";
 import { logBanner, logVariable } from "../helpers/cli.helper";
 import { getVersion } from "../helpers/version.helper";
 import { getBuilder, YargOption } from "../helpers/yargs.helper";
 import { generate, GenerateParams } from "./generate";
-import { DEFAULT_GENERATE_OPTIONS } from "src/generators/const/options.const";
 
 class GenerateOptions implements GenerateParams {
   @YargOption({ envAlias: "input", demandOption: true })
@@ -24,6 +24,16 @@ class GenerateOptions implements GenerateParams {
   @YargOption({ envAlias: "excludeTags", default: DEFAULT_GENERATE_OPTIONS.excludeTags.join(",") })
   excludeTags!: string;
 
+  @YargOption({ envAlias: "excludePathRegex", default: DEFAULT_GENERATE_OPTIONS.excludePathRegex })
+  excludePathRegex!: string;
+
+  @YargOption({
+    envAlias: "excludeRedundantZodSchemas",
+    default: DEFAULT_GENERATE_OPTIONS.excludeRedundantZodSchemas,
+    type: "boolean",
+  })
+  excludeRedundantZodSchemas!: boolean;
+
   @YargOption({ envAlias: "importPath", default: DEFAULT_GENERATE_OPTIONS.importPath })
   importPath!: "ts" | "relative" | "absolute";
 

src/generators/checkOpenAPIDoc.ts

@@ -23,10 +23,10 @@ export function checkOpenAPIDoc(openApiDoc: OpenAPIV3.Document, cliOptions?: Par
       );
     });
   } else {
-    const outputs = [...data.keys()].reduce((acc, tag) => {
-      const excludedTag = options.excludeTags.find((excludeTag) => excludeTag.toLowerCase() === tag.toLowerCase());
-      return excludedTag ? acc : [...acc, ...getOutputFileNames(tag, options)];
-    }, [] as string[]);
+    const outputs = [...data.keys()].reduce(
+      (acc, tag) => [...acc, ...getOutputFileNames(tag, options)],
+      [] as string[],
+    );
     console.log(`${chk.green("Outputs:")}\n${outputs.map((output) => `- ${output}`).join("\n")}\n`);
   }
 

src/generators/const/options.const.ts

@@ -8,7 +8,9 @@ export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
   output: "output",
   splitByTags: true,
   defaultTag: "Common",
-  excludeTags: [], // TODO: Only works for isolated tags
+  excludeTags: [],
+  excludePathRegex: "",
+  excludeRedundantZodSchemas: true,
   tsNamespaces: true,
   importPath: "ts",
   configs: {

src/generators/core/SchemaResolver.class.ts

@@ -10,13 +10,18 @@ import {
   autocorrectRef,
   getSchemaNameByRef,
   getSchemaRef,
-  getUniqueOperationName,
-  getUniqueOperationNamesWithoutSplitByTags,
   isMediaTypeAllowed,
   isParamMediaTypeAllowed,
+  isPathExcluded,
 } from "../utils/openapi.utils";
+import {
+  getOperationsByTag,
+  getUniqueOperationName,
+  getUniqueOperationNamesWithoutSplitByTags,
+  isOperationExcluded,
+} from "../utils/operation.utils";
 import { snakeToCamel } from "../utils/string.utils";
-import { formatTag, getOperationsByTag, getOperationTag } from "../utils/tag.utils";
+import { formatTag, getOperationTag } from "../utils/tag.utils";
 import {
   getBodyZodSchemaName,
   getResponseZodSchemaName,
@@ -26,18 +31,17 @@ import {
 import { DependencyGraph, getOpenAPISchemaDependencyGraph } from "./openapi/getOpenAPISchemaDependencyGraph";
 import { getDeepSchemaRefObjs, getSchemaRefObjs } from "./openapi/getSchemaRefObjs";
 import { ZodSchema } from "./zod/ZodSchema.class";
+import { resolveExtractedEnumZodSchemaNames } from "./zod/enumExtraction/resolveExtractedEnumZodSchemaNames";
+import { resolveExtractedEnumZodSchemaTags } from "./zod/enumExtraction/resolveExtractedEnumZodSchemaTags";
+import { updateExtractedEnumZodSchemaData } from "./zod/enumExtraction/updateExtractedEnumZodSchemaData";
 import { getEnumZodSchemasFromOpenAPIDoc } from "./zod/getZodSchemasFromOpenAPIDoc";
-import {
-  resolveExtractedEnumZodSchemaNames,
-  resolveExtractedEnumZodSchemaTags,
-  updateExtractedEnumZodSchemaData,
-} from "./zod/updateExtractedEnumZodSchemaData";
 
 interface SchemaData {
   ref: string;
   name: string;
   zodSchemaName: string;
   tags: string[];
+  deepRefOperations: OperationObject[];
 }
 
 interface ZodSchemaData {
@@ -110,6 +114,10 @@ export class SchemaResolver {
     return this.docSchemas[getSchemaNameByRef(ref)] as OpenAPIV3.SchemaObject;
   }
 
+  getSchemaDataByName(name: string) {
+    return this.schemaData.find((data) => data.name === name);
+  }
+
   getZodSchemaNameByRef(ref: string) {
     const zodSchemaName =
       this.getSchemaDataByRef(autocorrectRef(ref))?.zodSchemaName ??
@@ -284,17 +292,20 @@ export class SchemaResolver {
       const correctRef = autocorrectRef(ref);
       const name = getSchemaNameByRef(correctRef);
       const zodSchemaName = getZodSchemaName(name, this.options.schemaSuffix);
-      this.schemaData.push({ ref: correctRef, name, zodSchemaName, tags: [] });
+      this.schemaData.push({ ref: correctRef, name, zodSchemaName, tags: [], deepRefOperations: [] });
     });
 
     for (const path in this.openApiDoc.paths) {
+      if (isPathExcluded(path, this.options)) {
+        continue;
+      }
+
       const pathItemObj = this.openApiDoc.paths[path] as OpenAPIV3.PathItemObject;
 
       const pathItem = pick(pathItemObj, ALLOWED_METHODS);
       for (const method in pathItem) {
         const operation = pathItem[method as keyof typeof pathItem] as OperationObject | undefined;
-
-        if (!operation || (operation.deprecated && !this.options.withDeprecatedEndpoints)) {
+        if (!operation || isOperationExcluded(operation, this.options)) {
           continue;
         }
 
@@ -380,6 +391,7 @@ export class SchemaResolver {
           const schemaData = this.getSchemaDataByRef(schemaRef);
           if (schemaData) {
             schemaData.tags.push(tag);
+            schemaData.deepRefOperations.push(operation);
           }
         });
       }

src/generators/core/endpoints/getEndpointsFromOpenAPIDoc.test.ts

@@ -1,6 +1,7 @@
 import SwaggerParser from "@apidevtools/swagger-parser";
 import { OpenAPIV3 } from "openapi-types";
 import { describe, expect, test } from "vitest";
+import { DEFAULT_GENERATE_OPTIONS } from "../../const/options.const";
 import { GenerateOptions } from "../../types/options";
 import { SchemaResolver } from "../SchemaResolver.class";
 import { getEndpointsFromOpenAPIDoc } from "./getEndpointsFromOpenAPIDoc";
@@ -83,8 +84,10 @@ const schemas = {
 } as const;
 
 const generateOptions = {
+  ...DEFAULT_GENERATE_OPTIONS,
+  tsNamespaces: false,
+  extractEnums: false,
   schemaSuffix: "",
-  defaultTag: "",
 } as GenerateOptions;
 
 describe("getEndpointsFromOpenAPIDoc", () => {

src/generators/core/endpoints/getEndpointsFromOpenAPIDoc.ts

@@ -4,6 +4,7 @@ import { STRING_SCHEMA, VOID_SCHEMA } from "src/generators/const/zod.const";
 import { OperationObject } from "src/generators/types/openapi";
 import { invalidVariableNameCharactersToCamel } from "src/generators/utils/js.utils";
 import { isReferenceObject } from "src/generators/utils/openapi-schema.utils";
+import { getUniqueOperationName, isOperationExcluded } from "src/generators/utils/operation.utils";
 import { formatTag, getOperationTag } from "src/generators/utils/tag.utils";
 import {
   getInvalidOperationIdError,
@@ -15,10 +16,10 @@ import { getResponseZodSchemaName } from "src/generators/utils/zod-schema.utils"
 import { Endpoint, EndpointParameter } from "../../types/endpoint";
 import { pick } from "../../utils/object.utils";
 import {
-  getUniqueOperationName,
   isErrorStatus,
   isMainResponseStatus,
   isMediaTypeAllowed,
+  isPathExcluded,
   replaceHyphenatedPath,
 } from "../../utils/openapi.utils";
 import { SchemaResolver } from "../SchemaResolver.class";
@@ -33,13 +34,17 @@ export function getEndpointsFromOpenAPIDoc(resolver: SchemaResolver) {
   const endpoints = [];
 
   for (const path in resolver.openApiDoc.paths) {
+    if (isPathExcluded(path, resolver.options)) {
+      continue;
+    }
+
     const pathItemObj = resolver.openApiDoc.paths[path] as OpenAPIV3.PathItemObject;
     const pathItem = pick(pathItemObj, ALLOWED_METHODS);
     const pathParameters = getParameters(pathItemObj.parameters ?? []);
 
     for (const method in pathItem) {
       const operation = pathItem[method as keyof typeof pathItem] as OperationObject | undefined;
-      if (!operation || (operation.deprecated && !resolver.options.withDeprecatedEndpoints)) {
+      if (!operation || isOperationExcluded(operation, resolver.options)) {
         continue;
       }
 

src/generators/core/getMetadataFromOpenAPIDoc.test.ts

@@ -404,15 +404,22 @@ describe("getMetadataFromOpenAPIDoc", async () => {
   ];
 
   test("getMetadataFromOpenAPIDoc", async () => {
-    const metadata = await getMetadataFromOpenAPIDoc(openApiDoc, DEFAULT_GENERATE_OPTIONS);
+    const metadata = await getMetadataFromOpenAPIDoc(openApiDoc, {
+      ...DEFAULT_GENERATE_OPTIONS,
+      excludeRedundantZodSchemas: false,
+    });
 
     expect(metadata.models).toEqual(models());
     expect(metadata.queries).toEqual(queries);
   });
 
   test("getMetadataFromOpenAPIDoc", async () => {
     const extractEnums = false;
-    const metadata = await getMetadataFromOpenAPIDoc(openApiDoc, { ...DEFAULT_GENERATE_OPTIONS, extractEnums });
+    const metadata = await getMetadataFromOpenAPIDoc(openApiDoc, {
+      ...DEFAULT_GENERATE_OPTIONS,
+      excludeRedundantZodSchemas: false,
+      extractEnums,
+    });
 
     expect(metadata.models).toEqual(models(extractEnums));
     expect(metadata.queries).toEqual(queries);