feat: multiline option

Author: scarf005

lib/src/cli.ts

@@ -34,7 +34,7 @@ cli.command("<input>", "path/url to OpenAPI/Swagger document as json/yaml")
         "When true, will make all properties of an object required by default (rather than the current opposite), unless an explicitly `required` array is set"
     )
     .option("--with-deprecated", "when true, will keep deprecated endpoints in the api output")
-    .option("--with-description", "when true, will add z.describe(xxx)")
+    .option("--with-description", "when true, will add z.describe(xxx), 'multiline' will keep newlines as is")
     .option(
         "--group-strategy",
         "groups endpoints by a given strategy, possible values are: 'none' | 'tag' | 'method' | 'tag-file' | 'method-file'"

lib/src/getZodiosEndpointDefinitionList.ts

@@ -226,7 +226,6 @@ export const getZodiosEndpointDefinitionList = (doc: OpenAPIObject, options?: Te
                             );
                         }
 
-
                         // this fallback is needed to autofix openapi docs that put the $ref in the wrong place
                         // (it should be in the mediaTypeObject.schema, not in the mediaTypeObject itself)
                         // https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#style-values (just above this anchor)
@@ -239,7 +238,9 @@ export const getZodiosEndpointDefinitionList = (doc: OpenAPIObject, options?: Te
                     }
 
                     if (options?.withDescription && paramSchema) {
-                        (paramSchema as SchemaObject).description = (paramItem.description ?? "")?.replace("\n", "");
+                        const desc = paramItem.description ?? "";
+                        (paramSchema as SchemaObject).description =
+                            options?.withDescription === "multiline" ? desc : desc?.replaceAll(/\n\s*/g, " ");
                     }
 
                     // resolve ref if needed, and fallback to default (unknown) value if needed

lib/src/template-context.ts

@@ -335,8 +335,12 @@ export type TemplateContextOptions = {
     defaultStatusBehavior?: "spec-compliant" | "auto-correct";
     willSuppressWarnings?: boolean;
     /**
-     * when true, will add z.describe(xxx)
+     * adds z.describe(xxx).
+     *
+     * - when true, will truncate newlines and trailing spaces into a single space.
+     * - when "multiline", will not truncate newlines.
+     *
      * @see https://github.com/astahmer/openapi-zod-client/pull/143
      */
-    withDescription?: boolean;
+    withDescription?: boolean | "multiline";
 };