Skip to content

Enable parsing of nested parameters for @callback JSDoc tag. #54681

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.

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 4 commits into from
Jun 29, 2023

Conversation

yin
Copy link
Contributor

@yin yin commented Jun 16, 2023

Fixes #36101

There was a conditional statement that prohibited parsing nested parameter types when the parent jsdoc tag is a @callback. The check was there, because a structure to store nested param information was not defined.

The structure has been added and the parser code was cleaned up. We only need to enable parsing nested parameters in code.

Attached is a test and updated baseline.

I am unfamiliar with tsc codebase, so suggestions for additional tests are welcome!

@typescript-bot typescript-bot added the For Backlog Bug PRs that fix a backlog bug label Jun 16, 2023
Copy link
Member

@sandersn sandersn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert the package/package-lock changes and I will merge this.

@@ -45,7 +45,7 @@
"fast-xml-parser": "^4.0.11",
"fs-extra": "^9.1.0",
"glob": "^8.1.0",
"hereby": "^1.6.4",
"hereby": "^1.8.1",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you probably shouldn't update hereby in this PR. Our overnight run regenerates package-lock.json to use the latest version.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for noticing. I reverted them, downgraded them to the correct packages, and re-run hereby.

@sandersn sandersn self-assigned this Jun 29, 2023
@sandersn sandersn merged commit 34f6e10 into microsoft:main Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
For Backlog Bug PRs that fix a backlog bug
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Support @callback nested parameter types for JSDoc
3 participants