Skip to content
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

Refactor to fix TypeScript errors in UserConfig.js #3384

Merged
merged 8 commits into from
Jul 29, 2024

Conversation

zachleat
Copy link
Member

From #3097, related: #3383

@zachleat
Copy link
Member Author

Notably this PR removes jsdoc (again) per incompatibilities here: jsdoc/jsdoc#1645

@zachleat zachleat changed the title TypeScript refactor, include type files. Refactor to fix TypeScript errors in UserConfig.js Jul 29, 2024
@zachleat zachleat merged commit 608a36c into main Jul 29, 2024
9 checks passed
@zachleat zachleat deleted the typescript-evaluation branch July 29, 2024 20:36
@mayank99
Copy link
Sponsor Contributor

For future reference, this is the correct documentation to look at when using JSDoc comments with tsc: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html

(https://jsdoc.app/ is different and will cause issues)

@zachleat
Copy link
Member Author

Appreciate that! The syntax seems to have diverged enough that I don’t think it’s worth trying to navigate both and I did consciously choose to prefer the TypeScript version moving forward (and removed our jsdoc npm scripts as part of this PR).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants