Skip to content

Fix crash when a field has 'deprecated', but not 'description' #549

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
merged 3 commits into from
Aug 29, 2023
Merged

Fix crash when a field has 'deprecated', but not 'description' #549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b5973d
Add failing test case
danmichaelo Aug 28, 2023
281d6f1
Fix crash when deprecated is defined without description
danmichaelo Aug 28, 2023
20f3045
Add test case for #540 too
danmichaelo Aug 28, 2023
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
6 changes: 4 additions & 2 deletions src/generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,12 +316,14 @@ function generateInterface(ast: TInterface, options: Options): string {
)
}

function generateComment(comment: string, deprecated?: boolean): string {
function generateComment(comment?: string, deprecated?: boolean): string {
const commentLines = ['/**']
if (deprecated) {
commentLines.push(' * @deprecated')
}
commentLines.push(...comment.split('\n').map(_ => ' * ' + _))
if (typeof comment !== 'undefined') {
commentLines.push(...comment.split('\n').map(_ => ' * ' + _))
}
commentLines.push(' */')
return commentLines.join('\n')
}
Expand Down
2 changes: 1 addition & 1 deletion test/__snapshots__/test/test.ts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -827,7 +827,6 @@ Generated by [AVA](https://avajs.dev).
export interface ExampleSchema {␊
/**␊
* @deprecated␊
* nested comment␊
*/␊
firstName: string;␊
/**␊
Expand All @@ -839,6 +838,7 @@ Generated by [AVA](https://avajs.dev).
* nested comment␊
*/␊
lastName?: string;␊
description?: string;␊
}␊
`

Expand Down
Binary file modified test/__snapshots__/test/test.ts.snap
View file
Open in desktop
Binary file not shown.
6 changes: 5 additions & 1 deletion test/e2e/deprecated.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ export const input = {
deprecated: true,
description: 'comment',
properties: {
// https://github.com/bcherny/json-schema-to-typescript/issues/548
firstName: {
type: 'string',
deprecated: true,
description: 'nested comment',
},
middleName: {
type: 'string',
Expand All @@ -20,6 +20,10 @@ export const input = {
deprecated: false,
description: 'nested comment',
},
// https://github.com/bcherny/json-schema-to-typescript/issues/540
description: {
type: 'string',
},
},
additionalProperties: false,
required: ['firstName'],
Expand Down