Skip to content

eslint-plugin-tsdoc: Missing rule to check for absence of a TSDoc comment #372

Open

Description

@WesSouza

The documentation eslint-plugin-tsdoc is very vague, as I understand there is only one rule that validates the entire comment block for syntax adherence, but not much else that is necessary for a complete linting solution.

For example: what is the equivalent of jsdoc/require-jsdoc?

Do I need to use jsdoc and tsdoc on my ESLint configuration?

Activity

  1. ayushjaipuriyarht commented on Mar 20, 2024

    @ayushjaipuriyarht

    The documentation eslint-plugin-tsdoc is very vague, as I understand there is only one rule that validates the entire comment block for syntax adherence, but not much else that is necessary for a complete linting solution.

    For example: what is the equivalent of jsdoc/require-jsdoc?

    Do I need to use jsdoc and tsdoc on my ESLint configuration?

    where you able to find anything on this ?

  2. svenvandescheur commented on Apr 4, 2025

    @svenvandescheur

    Would be nice to have something like this for packages that rely on docstring annotations to generate documentation 👍 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions