Add comment generation to TypeScript interfaces #61
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TRobboJ
commented
Jul 2, 2025
| @@ -81,6 +81,12 @@ export const AUTHORS_TABLE_CREATES = [ | |||
| full_name VARCHAR(80) not null | |||
| ); | |||
| `, | |||
| `EXEC sp_addextendedproperty | |||
There was a problem hiding this comment.
I've updated all the tests to add their version of a comment and they all pass when I run them.
There was a problem hiding this comment.
Exception is sqllite as it doesn't support comments
TRobboJ
commented
Jul 2, 2025
| ))) | ||
| ts.factory.createTypeReferenceNode(dialect.mapDbTypeToJs(c.type) ?? 'any', undefined) | ||
| ) | ||
| return c.comment ? ts.addSyntheticLeadingComment(property, ts.SyntaxKind.MultiLineCommentTrivia, `* ${c.comment}`, true) : property |
There was a problem hiding this comment.
Main change here to add the comments using addSyntheticLeadingComment
|
This is amazing we've been wanting this exact feature!! +1 to get this merged in. |
|
This would help a lot! Thank you for updating this. +1 vote in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi there,
Just adding any database comments to the TypeScript interface to help with typehints.