eslint-config-auto icon indicating copy to clipboard operation
eslint-config-auto copied to clipboard

Published 20 hours ago • verified publisher icon davidjbradshaw

Add `eslint-plugin-tsdoc`

Open alecmev opened this issue 3 years ago • 3 comments

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

alecmev avatar Aug 10 '22 19:08 alecmev

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?

davidjbradshaw avatar Aug 10 '22 20:08 davidjbradshaw

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.

alecmev avatar Aug 10 '22 21:08 alecmev

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

davidjbradshaw avatar Aug 14 '22 16:08 davidjbradshaw