@requires not being parsed as expected

[PetarMax]

I'm having problems (see below) with the parsing of the @requires tag. Is it reserved/special in some way?

Thanks,
Petar

What version are you using?
1.5.0

What JSDoc comment were you trying to parse?
/** @requires this and that */

What Doctrine options were you using (sloppy, unwrap, etc.)?
unwrap : true

What happened? Include output if possible.
{ "description": "", "tags": [] }

What did you expect to happen?
{ "description": "", "tags": [ { "title": "requires", "description": "this and that" } ] }

[nzakas]

Hmm, I'm not sure. It could be a bug, but unfortunately I probably won't have time to investigate for a while. Do you have any interest in digging into the problem?

[mdasberg]

any update?

[platinumazure]

@mdasberg I don't believe anyone has had time to investigate. If you have time to investigate and send a PR, we would be hugely grateful.

@eslint/doctrine-team Pinging in case anyone can provide a more accurate update.

[tmcw]

Sure, trying this out in the demo reveals the cause:

The syntax of @requires allows a namepath after the tag, but not a description, so the input is invalid.

[kaicataldo]

Thanks for this issue. We have decided to officially end-of-life JSDoc support in ESLint. As a result, this repository and project will no longer be maintained.

Thanks for understanding and we apologize for any inconvenience.