Apply JSDoc Comments to Lua code#1270
Merged
Perryvw merged 13 commits intoTypeScriptToLua:masterfrom May 30, 2022
Zamiell:comments
Merged
Apply JSDoc Comments to Lua code#1270Perryvw merged 13 commits intoTypeScriptToLua:masterfrom Zamiell:comments
Perryvw merged 13 commits intoTypeScriptToLua:masterfrom
Zamiell:comments
Conversation
lolleko
reviewed
May 28, 2022
Member
|
Could you make this respect the removeComments tsconfig configuration value |
Contributor
Author
|
done |
Perryvw
reviewed
May 29, 2022
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes #815, sort-of-but-not-really.
According to this StackOverlow page, it is not possible to get single-line comments in the AST. However, it is possible to extract JSDoc comments that are specifically attached to functions and variables.
So, for this PR, I simply extract JSDoc where I can, and then stick it on the "leadingComments" property that Perry added in 0fba69b.
This works, and seems good for a first iteration of the feature.
A better solution would be to:
However, how do we find the correct spot in the generated Lua that corresponds with this spot in the source code? Is that possible?