davidjbradshaw / eslint-config-auto

Automatically configure ESLint based on project dependencies

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add `eslint-plugin-tsdoc`

alecmev opened this issue · comments

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?

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.

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