deno_lint icon indicating copy to clipboard operation
deno_lint copied to clipboard

Published 20 hours ago • verified publisher icon denoland

feat: add require-jsdoc rule

Open ah-yu opened this issue 2 years ago • 4 comments

ref #970

ah-yu avatar Nov 15 '21 09:11 ah-yu

added interfaces/classes jsdoc comment checks. eslint-plugin-jsdoc/require-jsdoc only checks FunctionDeclaration by default, should we check classes/interfaces by default? ref: https://github.com/gajus/eslint-plugin-jsdoc#require

ah-yu avatar Nov 16 '21 11:11 ah-yu

@ah-yu the PR looked okay, what's the reason to close it?

bartlomieju avatar Nov 19 '21 11:11 bartlomieju

@dsherret please review, should we add more feature before landing?

bartlomieju avatar Dec 01 '21 20:12 bartlomieju

@bartlomieju Sorry for late response, I was kind of busy those days so I closed this PR. And I'd like to finish it.

ah-yu avatar Dec 02 '21 03:12 ah-yu

Hi @ah-yu, is there any way we could progress this PR? This change could be valuable for modules that'd like to enforce documentation.

iuioiua avatar Dec 20 '22 21:12 iuioiua

It would be definitely great to have something like rust #![warn(missing_docs)] hopefully this gets picked up again, its really useful for library authors (and in my opinion it should be opt in like rust's)

sigmaSd avatar Jun 27 '23 17:06 sigmaSd

Thanks, but we ended up going with a much more powerful linting system as part of deno doc. For details, see this PR https://github.com/denoland/deno/pull/21032

dsherret avatar Oct 31 '23 22:10 dsherret