Skip to content

fix(plugin): generate object examples from @example doc tags #4005

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

Merged
kamilmysliwiec merged 1 commit into from
Aug 17, 2026
Merged

fix(plugin): generate object examples from @example doc tags #4005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 19 additions & 5 deletions lib/plugin/utils/ast-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,10 +422,24 @@ export function createPrimitiveLiteral(
export function createLiteralFromAnyValue(
factory: ts.NodeFactory,
item: unknown
) {
return Array.isArray(item)
? factory.createArrayLiteralExpression(
item.map((item) => createLiteralFromAnyValue(factory, item))
): ts.Expression {
if (Array.isArray(item)) {
return factory.createArrayLiteralExpression(
item.map((item) => createLiteralFromAnyValue(factory, item))
);
}
if (item === null) {
return factory.createNull();
}
if (typeof item === 'object') {
return factory.createObjectLiteralExpression(
Object.entries(item).map(([key, value]) =>
factory.createPropertyAssignment(
factory.createStringLiteral(key),
createLiteralFromAnyValue(factory, value)
)
)
: createPrimitiveLiteral(factory, item);
);
}
return createPrimitiveLiteral(factory, item);
}
9 changes: 8 additions & 1 deletion test/plugin/fixtures/create-cat-alt2.dto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,13 @@ export abstract class Audit {
*/
testNumber: number;

/**
* testObject
*
* @example { "Content-Type": "video/mp4", "key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }
*/
testObject: Record<string, string>;

/**
* privateProperty
* @example 'secret'
Expand All @@ -102,7 +109,7 @@ export class Audit {
_Audit_privateProperty.set(this, void 0);
}
static _OPENAPI_METADATA_FACTORY() {
return { createdAt: { required: true, type: () => Object, description: "test on createdAt" }, updatedAt: { required: true, type: () => Object }, version: { required: true, type: () => String, description: "test\\nversion", example: "version 123" }, testVersion: { required: true, type: () => Object, description: "testVersion", examples: ["0.0.1", "0.0.2"], deprecated: true }, testVersion2: { required: true, type: () => Object, description: "testVersion2", examples: ["0.0.1", "0.0.2"], deprecated: true }, testVersionArray: { required: true, type: () => [String], description: "testVersionArray", example: ["0.0.1", "0.0.2"] }, testVersionArray2: { required: true, type: () => [String], description: "testVersionArray", example: ["version 123", "version 321"] }, testVersionArray3: { required: true, type: () => [Number], description: "testVersionArray", example: [123, 321] }, testBoolean: { required: true, type: () => Boolean, description: "testBoolean", example: true }, testNumber: { required: true, type: () => Number, description: "testNumber", examples: [1, 5] } };
return { createdAt: { required: true, type: () => Object, description: "test on createdAt" }, updatedAt: { required: true, type: () => Object }, version: { required: true, type: () => String, description: "test\\nversion", example: "version 123" }, testVersion: { required: true, type: () => Object, description: "testVersion", examples: ["0.0.1", "0.0.2"], deprecated: true }, testVersion2: { required: true, type: () => Object, description: "testVersion2", examples: ["0.0.1", "0.0.2"], deprecated: true }, testVersionArray: { required: true, type: () => [String], description: "testVersionArray", example: ["0.0.1", "0.0.2"] }, testVersionArray2: { required: true, type: () => [String], description: "testVersionArray", example: ["version 123", "version 321"] }, testVersionArray3: { required: true, type: () => [Number], description: "testVersionArray", example: [123, 321] }, testBoolean: { required: true, type: () => Boolean, description: "testBoolean", example: true }, testNumber: { required: true, type: () => Number, description: "testNumber", examples: [1, 5] }, testObject: { required: true, type: "object", additionalProperties: { type: "string" }, description: "testObject", example: { "Content-Type": "video/mp4", "key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } } };
}
}
_Audit_privateProperty = new WeakMap();
Expand Down