Skip to content

Cryptic "Missing or invalid tag name" lint #574

Open
@jfirebaugh

Description

@jfirebaugh

Test case:

/**
 * Description goes here
 *
 * @param {Array<StructMember>}
 */

Lint output:

  155:1  warning  Missing or invalid tag name

Issues:

  • The line number refers to the start of the comment. It should refer to the @param line.
  • The message is wishy washy. Is the name missing, or is it invalid? Figure it out and tell me.
  • The message is vague. It should say something like The @param tag requires a parameter name.
  • If the type is simpler, like {number}, the lint does not trigger. I can't see why it shouldn't.
  • Bonus points: lint could suggest a name based on the code that follows. "Did you mean members?"

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions