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

feature request: add doc comments linting #1279

Open
lowlighter opened this issue May 30, 2024 · 0 comments
Open

feature request: add doc comments linting #1279

lowlighter opened this issue May 30, 2024 · 0 comments
Labels
request Feature request

Comments

@lowlighter
Copy link

Since these are used on jsr.io for documentation (but even for deno doc or other doc generators), it'd be nice to add a few rules to lint comment docs like:

no-undocumented-exported-member: All exported members should have a doc comment:

export function bad() {}

/** This function does stuff. */
export function good() {}

sentence-doc-comment: All single line doc comment should starts with an uppercase letter and ends with a final dot.

/** this function does stuff */
export function bad() {}

/** This function does stuff. */
export function good() {}

example-in-doc-comment: All multiline doc comment should contain an example (maybe make this one optional ?)

/**
 * This function does stuff.
 * 
 *  Lorem ipsum... 
 *  Blah blah blah... 
 */
export function bad() {}

/**
 * This function does stuff.
 * 
 *  Lorem ipsum... 
 *  Blah blah blah...
 *
 * @example
 * ```ts
 * good() 
 * ```  
 */
export function good() {}
@bartlomieju bartlomieju added the request Feature request label May 30, 2024
@lucacasonato lucacasonato added request Feature request and removed request Feature request labels Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
request Feature request
Projects
None yet
Development

No branches or pull requests

3 participants