chore(traverse): add JSDoc type hints to JS codegen scripts #6375
Conversation
This file contains 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
Your org has enabled the Graphite merge queue for merging into mainAdd the label “0-merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix. You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link. |
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
DonIsaac
added
the
C-cleanup
Graphite App
|
I need this merged before I can complete #6350. |
DonIsaac
force-pushed
the
don/10-08-chore_traverse_add_jsdoc_type_hints_to_js_codegen_scripts
branch
from
98bfac9
to
2696201
Compare
overlookmotel
approved these changes
Oct 8, 2024
Merge activity
|
Use JSDoc comments in `build.mjs` and related scripts to provide type hints and better intellisense. I was having a hard time knowing what fields are available in different methods, and I found this quite helpful. I'm sure other newcomers to this part of our codegen infrastructure will find it helpful as well.
overlookmotel
force-pushed
the
don/10-08-chore_traverse_add_jsdoc_type_hints_to_js_codegen_scripts
branch
from
2696201
to
d5cf1f8
Compare
|
Thanks Don. This codegen was written in a bit of a "quick and dirty" manner. It was never intended to live this long - it was just a proof of concept initially, and I intended to translate it to Rust and make it part of So that's why it's poorly written and lacking comments. |
graphite-app
bot
deleted the
don/10-08-chore_traverse_add_jsdoc_type_hints_to_js_codegen_scripts
branch
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.
Use JSDoc comments in
build.mjsand related scripts to provide type hints and better intellisense. I was having a hard time knowing what fields are available in different methods, and I found this quite helpful. I'm sure other newcomers to this part of our codegen infrastructure will find it helpful as well.