Skip to content

Poor lint output for invalid @typedef #372

Open
@jfirebaugh

Description

@jfirebaugh
/**
 * @typedef Comment
 */

Actual error message from documentation lint:

/path/filename.js
        1:1  warning  Missing or invalid tag type
        1:1  warning  could not determine @name for hierarchy

The line number is wrong and there's no indication that the issue is with the @typedef. If lint wants to complain that @typedef should specify a type, a good error message would be:

/path/filename.js
        2:1  warning  @typedef without a type. Expected `@typedef <type> <namepath>`.

However, according to JSDoc docs, <type> is actually optional. So the fact that lint is even complaining might be a bug in documentationjs.

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