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

Add eslint-plugin-tsdoc #56

Open
alecmev opened this issue Aug 10, 2022 · 3 comments
Open

Add eslint-plugin-tsdoc #56

alecmev opened this issue Aug 10, 2022 · 3 comments

Comments

@alecmev
Copy link

alecmev commented Aug 10, 2022

I think it fits in, right? https://github.com/microsoft/tsdoc/tree/main/eslint-plugin

@davidjbradshaw
Copy link
Owner

Yeah I think it would be reasonable to detect TSDoc and load the limiting rules in as required. I guess we should also do the same with JSDoc

Would you like to make a PR for both?

@alecmev
Copy link
Author

alecmev commented Aug 10, 2022

detect TSDoc

Hmm, I'm not sure how to go about that. We stick to the standard for better hints, but we don't generate any documentation, so there's no @microsoft/tsdoc in our lockfile. Is there a downside to enabling it for all TypeScript projects? It isn't obtrusive, just in case, I don't remember it complaining about something it shouldn't complain about.

I guess we should also do the same with JSDoc

Sure! Same question about the detection though.

@davidjbradshaw
Copy link
Owner

I think the downside is not everyone uses TSdoc or JSdoc. So we don’t want to force this onto them.

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

2 participants