documentationjs / documentationjs/documentation

Poor lint output for invalid @typedef

Open
#372 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

```
/**
* @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 `.
```

However, according to [JSDoc docs](http://usejsdoc.org/tags-typedef.html), `` is actually optional. So the fact that lint is even complaining might be a bug in documentationjs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.