Merge pull request #15 from povio/feature/enums

Enum extraction, Check for inline enums & Minor refactoring

Author: monikaboz

README.md

@@ -20,21 +20,32 @@ yarn openapi-codegen generate --input http://localhost:3001/docs-json
 
 ## Options
 
-### Generate command
+### Generate command (generates Zod schemas, API definitions and React queries)
 
 ```sh
-  --input <path>                      Path/url to OpenAPI/Swagger document as json/yaml
-  --output <path>                     Output path (default: 'output')
+  --input                             Path/url to OpenAPI/Swagger document as json/yaml
+  --output                            Output path (default: 'output')
   --includeNamespaces                 Include namespaces inside generated files (default: true)
   --splitByTags                       Split output into directories based on tags in OpenAPI operations (default: true)
   --defaultTag                        Default tag name for code shared accross multiple tags (default: 'Common')
   --excludeTags                       Comma separated list of tags excluded from the output
+  --extractEnums                      Enums are extracted as seperate Zod schemas (default: true)
   --removeOperationPrefixEndingWith   Removes prefix that ends with value from operation names (default: 'Controller_')
   --importPath                        Import path (default: 'ts', possible: 'ts' | 'relative' | 'absolute')
   --prettier                          Run prettier command on output after code generation (default: true)
   --verbose                           Show log messages during execution
 ```
 
+### Check command (checks if OpenAPI spec is compliant)
+
+```sh
+  --input                             Path/url to OpenAPI/Swagger document as json/yaml
+  --splitByTags                       Split output into directories based on tags in OpenAPI operations (default: true)
+  --defaultTag                        Default tag name for code shared accross multiple tags (default: 'Common')
+  --excludeTags                       Comma separated list of tags excluded from the output
+  --verbose                           Show log messages during execution
+```
+
 ## Development
 
 ### Test locally

package.json

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

src/commands/check.ts

@@ -10,6 +10,8 @@ export type CheckParams = {
 } & Pick<GenerateOptions, "input" | "splitByTags" | "defaultTag">;
 
 export async function check({ input, excludeTags, verbose, ...params }: CheckParams) {
+  const start = Date.now();
+
   if (verbose) {
     logInfo("Parsing OpenAPI spec...");
   }
@@ -21,15 +23,16 @@ export async function check({ input, excludeTags, verbose, ...params }: CheckPar
   if (verbose) {
     logInfo("Running check...");
   }
-  const errorMessages = checkOpenAPIDoc({
-    openApiDoc,
-    options: {
-      input,
-      excludeTags: excludeTags.split(","),
-      ...params,
-    },
+  const errorMessages = checkOpenAPIDoc(openApiDoc, {
+    input,
+    excludeTags: excludeTags.split(","),
+    ...params,
   });
 
+  if (verbose) {
+    logInfo(`TIME: ${Date.now() - start}ms`);
+  }
+
   if (errorMessages.length === 0) {
     logSuccess("Check finished.");
   } else {

src/commands/generate.command.ts

@@ -26,6 +26,9 @@ class GenerateOptions implements GenerateParams {
   @YargOption({ envAlias: "importPath", default: "ts", type: "string" })
   importPath!: "ts" | "relative" | "absolute";
 
+  @YargOption({ envAlias: "extractEnums", default: true, type: "boolean" })
+  extractEnums!: boolean;
+
   @YargOption({ envAlias: "removeOperationPrefixEndingWith", default: "Controller_" })
   removeOperationPrefixEndingWith!: string;
 

src/commands/generate.ts

@@ -18,9 +18,12 @@ export type GenerateParams = {
   | "defaultTag"
   | "removeOperationPrefixEndingWith"
   | "importPath"
+  | "extractEnums"
 >;
 
 export async function generate({ input, excludeTags, prettier, verbose, ...params }: GenerateParams) {
+  const start = Date.now();
+
   if (verbose) {
     logInfo("Parsing OpenAPI spec...");
   }
@@ -32,13 +35,10 @@ export async function generate({ input, excludeTags, prettier, verbose, ...param
   if (verbose) {
     logInfo("Generating code...");
   }
-  generateCodeFromOpenAPIDoc({
-    openApiDoc,
-    options: {
-      input,
-      excludeTags: excludeTags.split(","),
-      ...params,
-    },
+  generateCodeFromOpenAPIDoc(openApiDoc, {
+    input,
+    excludeTags: excludeTags.split(","),
+    ...params,
   });
   if (verbose) {
     logSuccess("Generation finished.");
@@ -47,6 +47,10 @@ export async function generate({ input, excludeTags, prettier, verbose, ...param
   if (prettier) {
     execPrettier({ output: params.output, verbose });
   }
+
+  if (verbose) {
+    logInfo(`TIME: ${Date.now() - start}ms`);
+  }
 }
 
 function execPrettier({ output, verbose }: Pick<GenerateParams, "output" | "verbose">) {

src/generators/checkOpenAPIDoc.ts

@@ -1,45 +1,40 @@
 import { OpenAPIV3 } from "openapi-types";
-import { logInfo } from "src/helpers/cli.helper";
+import { chk } from "src/helpers/chalk.helper";
 import { DEFAULT_GENERATE_OPTIONS } from "./const/options.const";
+import { VALIDATION_ERROR_TYPE_TITLE } from "./const/validation.const";
 import { getDataFromOpenAPIDoc } from "./core/getDataFromOpenAPIDoc";
 import { GenerateType } from "./types/generate";
 import { GenerateOptions } from "./types/options";
+import { ValidationErrorType } from "./types/validation";
 import { getFileName } from "./utils/file.utils";
 import { getTagFileName } from "./utils/generate/generate.utils";
+import { groupByType } from "./utils/validation.utils";
 
-export function checkOpenAPIDoc({
-  openApiDoc,
-  options: cliOptions,
-}: {
-  openApiDoc: OpenAPIV3.Document;
-  options?: Partial<GenerateOptions>;
-}) {
+export function checkOpenAPIDoc(openApiDoc: OpenAPIV3.Document, cliOptions?: Partial<GenerateOptions>) {
   const options = { ...DEFAULT_GENERATE_OPTIONS, ...cliOptions } as GenerateOptions;
 
-  const { resolver, data, validationErrorMessages } = getDataFromOpenAPIDoc({ openApiDoc, options });
+  const { resolver, data } = getDataFromOpenAPIDoc(openApiDoc, options);
 
-  const errorMessages = [...validationErrorMessages, ...resolver.validationErrorMessages];
-  if (errorMessages.length > 0) {
-    logInfo(`Issues:\n${errorMessages.map((message) => `- ${message}`).join("\n")}`);
+  if (resolver.validationErrors.length > 0) {
+    const groupedErrors = groupByType(resolver.validationErrors);
+    Object.entries(groupedErrors).forEach(([type, errorMessages]) => {
+      console.log(
+        `${chk.red(`${VALIDATION_ERROR_TYPE_TITLE[type as ValidationErrorType]}:`)}\n${errorMessages.map((message) => `- ${message}`).join("\n")}\n`,
+      );
+    });
   } else {
     const outputs = [...data.keys()].reduce((acc, tag) => {
-      const excludedTagIndex = options.excludeTags?.findIndex(
-        (excludeTag) => excludeTag.toLocaleLowerCase() === tag.toLocaleLowerCase(),
-      );
-      const isExcludedTag = excludedTagIndex !== -1;
-      if (isExcludedTag) {
-        return acc;
-      }
-
-      return [
-        ...acc,
-        ...[GenerateType.Models, GenerateType.Endpoints, GenerateType.Queries].map((type) =>
-          getFileName({ output: options.output, fileName: getTagFileName({ tag, type, options }) }),
-        ),
-      ];
+      const excludedTag = options.excludeTags.find((excludeTag) => excludeTag.toLowerCase() === tag.toLowerCase());
+      return excludedTag ? acc : [...acc, ...getTagOutputFileNames(tag, options)];
     }, [] as string[]);
-    logInfo(`Output:\n${outputs.map((message) => `- ${message}`).join("\n")}`);
+    console.log(`${chk.green("Outputs:")}\n${outputs.map((output) => `- ${output}`).join("\n")}\n`);
   }
 
-  return errorMessages;
+  return resolver.validationErrors;
+}
+
+function getTagOutputFileNames(tag: string, options: GenerateOptions) {
+  return [GenerateType.Models, GenerateType.Endpoints, GenerateType.Queries].map((type) =>
+    getFileName({ output: options.output, fileName: getTagFileName({ tag, type, options }) }),
+  );
 }

src/generators/const/options.const.ts

@@ -1,6 +1,6 @@
 import { GenerateType } from "../types/generate";
 import { GenerateOptions } from "../types/options";
-import { SCHEMA_SUFFIX } from "./zod.const";
+import { ENUM_SUFFIX, SCHEMA_SUFFIX } from "./zod.const";
 
 export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
   // Base options
@@ -11,6 +11,7 @@ export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
   excludeTags: [], // TODO: Only works for isolated tags
   includeNamespaces: true,
   importPath: "ts",
+  extractEnums: true,
   configs: {
     [GenerateType.Models]: {
       outputFileNameSuffix: "models",
@@ -27,6 +28,7 @@ export const DEFAULT_GENERATE_OPTIONS: GenerateOptions = {
   },
   // Zod options
   schemaSuffix: SCHEMA_SUFFIX,
+  enumSuffix: ENUM_SUFFIX,
   additionalPropertiesDefaultValue: false,
   // Endpoints options
   removeOperationPrefixEndingWith: "Controller_",

src/generators/const/validation.const.ts

@@ -0,0 +1,8 @@
+import { ValidationErrorType } from "../types/validation";
+
+export const VALIDATION_ERROR_TYPE_TITLE: Record<ValidationErrorType, string> = {
+  "invalid-schema": "Invalid Schemas",
+  "invalid-operation-id": "Invalid Operation IDs",
+  "missing-path-parameter": "Missing Path Parameters",
+  "not-allowed-inline-enum": "Not Allowed Inline Enums",
+};

src/generators/const/zod.const.ts

@@ -1,6 +1,7 @@
 import { Import } from "../types/generate";
 
 export const SCHEMA_SUFFIX = "Schema";
+export const ENUM_SUFFIX = "Enum";
 export const BODY_SCHEMA_SUFFIX = "Body";
 export const PARAM_SCHEMA_SUFFIX = "Param";
 export const RESPONSE_SCHEMA_SUFFIX = "Response";