Skip to content

fix: escape backticks in multiline descriptions with withDescription option #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: escape backticks in multiline descriptions with withDescription option #337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f2cb1d
fix: escape backticks in multiline descriptions with withDescription …
mola1129 Jun 5, 2025
c53c8ab
Add comprehensive test cases for quote escaping scenarios
mola1129 Jun 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions lib/src/openApiToZod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,11 +312,12 @@ export const getZodChain = ({ schema, meta, options }: ZodChainArgs) => {
.otherwise(() => void 0);

if (typeof schema.description === "string" && schema.description !== "" && options?.withDescription) {
if (["\n", "\r", "\r\n"].some((c) => String.prototype.includes.call(schema.description, c))) {
chains.push(`describe(\`${schema.description}\`)`);
} else {
chains.push(`describe("${schema.description}")`);
}
const isMultiline = /[\n\r]/.test(schema.description);
const quote = isMultiline ? "`" : '"';
const escapedDescription = isMultiline
? schema.description.replace(/`/g, "\\`")
: schema.description.replace(/"/g, '\\"');
chains.push(`describe(${quote}${escapedDescription}${quote})`);
}

const output = chains
Expand Down
209 changes: 208 additions & 1 deletion lib/tests/description-in-zod.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,102 @@ test("description-in-zod", async () => {
},
description: " ", // spaces only description
},
{
in: "query",
name: "multilineBackticks",
schema: {
type: "string",
},
description: "`Multiline`\n with \n`backticks`\n",
},
{
in: "query",
name: "singleLineBackticks",
schema: {
type: "string",
},
description: "`Single line` with `backticks`",
},
{
in: "query",
name: "multiLineDoubleQuotes",
schema: {
type: "string",
},
description: '"Multiline"\n with \n"double quotes"\n',
},
{
in: "query",
name: "singleLineDoubleQuotes",
schema: {
type: "string",
},
description: '"Single line" with "double quotes"',
},
{
in: "query",
name: "multilineMixedQuotes",
schema: {
type: "string",
},
description: 'Multiline with `backticks`\n and "double quotes"\n',
},
{
in: "query",
name: "singleLineMixedQuotes",
schema: {
type: "string",
},
description: 'Single line with `backticks` and "double quotes"',
},
{
in: "query",
name: "carriageReturnBackticks",
schema: {
type: "string",
},
description: "Carrige return with `backticks`\r",
},
{
in: "query",
name: "carriageReturnDoubleQuotes",
schema: {
type: "string",
},
description: 'Carrige return with "double quotes"\r',
},
{
in: "query",
name: "carriageReturnMixedQuotes",
schema: {
type: "string",
},
description: 'Carrige return with `backticks` and "double quotes"\r',
},
{
in: "query",
name: "windowsStyleNewlineWithBackticks",
schema: {
type: "string",
},
description: "Windows style newline with `backticks`\r\n",
},
{
in: "query",
name: "windowsStyleNewlineWithDoubleQuotes",
schema: {
type: "string",
},
description: 'Windows style newline with "double quotes"\r\n',
},
{
in: "query",
name: "windowsStyleNewlineWithMixedQuotes",
schema: {
type: "string",
},
description: 'Windows style newline with `backticks` and "double quotes"\r\n',
},
],
responses: {
"200": {
Expand Down Expand Up @@ -96,7 +192,9 @@ test("description-in-zod", async () => {
schema: z
.union([z.literal(1.3), z.literal(34.1), z.literal(-57.89)])
.describe(
\`baz\nmultiline\ndescription\`
\`baz
multiline
description\`
)
.optional(),
},
Expand All @@ -105,6 +203,115 @@ test("description-in-zod", async () => {
type: "Query",
schema: z.string().optional(),
},
{
name: "multilineBackticks",
type: "Query",
schema: z
.string()
.describe(
\`\\\`Multiline\\\`
with
\\\`backticks\\\`\`
)
.optional(),
},
{
name: "singleLineBackticks",
type: "Query",
schema: z
.string()
.describe("\`Single line\` with \`backticks\`")
.optional(),
},
{
name: "multiLineDoubleQuotes",
type: "Query",
schema: z
.string()
.describe(
\`"Multiline"
with
"double quotes"\`
)
.optional(),
},
{
name: "singleLineDoubleQuotes",
type: "Query",
schema: z
.string()
.describe('"Single line" with "double quotes"')
.optional(),
},
{
name: "multilineMixedQuotes",
type: "Query",
schema: z
.string()
.describe(
\`Multiline with \\\`backticks\\\`
and "double quotes"\`
)
.optional(),
},
{
name: "singleLineMixedQuotes",
type: "Query",
schema: z
.string()
.describe('Single line with \`backticks\` and "double quotes"')
.optional(),
},
{
name: "carriageReturnBackticks",
type: "Query",
schema: z
.string()
.describe("Carrige return with \`backticks\`")
.optional(),
},
{
name: "carriageReturnDoubleQuotes",
type: "Query",
schema: z
.string()
.describe('Carrige return with "double quotes"')
.optional(),
},
{
name: "carriageReturnMixedQuotes",
type: "Query",
schema: z
.string()
.describe('Carrige return with \`backticks\` and "double quotes"')
.optional(),
},
{
name: "windowsStyleNewlineWithBackticks",
type: "Query",
schema: z
.string()
.describe("Windows style newline with \`backticks\`")
.optional(),
},
{
name: "windowsStyleNewlineWithDoubleQuotes",
type: "Query",
schema: z
.string()
.describe('Windows style newline with "double quotes"')
.optional(),
},
{
name: "windowsStyleNewlineWithMixedQuotes",
type: "Query",
schema: z
.string()
.describe(
'Windows style newline with \`backticks\` and "double quotes"'
)
.optional(),
},
],
response: z.void(),
},
Expand Down