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

Use twoslash to create an eslint rule that validates jsdoc example tags #794

Open
moldy530 opened this issue Jun 27, 2024 · 1 comment
Open

Comments

@moldy530
Copy link
Collaborator

No description provided.

@moldy530
Copy link
Collaborator Author

Once #793 is done, we can enforce that the example tags which contain twoslash directives in them compile appropriately using: import { twoslasher } from "@typescript/twoslash";

We can extend our eslint plugin rules to run this check and then appropriately throw lint errors when examples don't compile. This would protect us during refactors and makes sure that there are no typos in the examples

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

No branches or pull requests

1 participant