documentationjs / documentationjs/documentation
Poor lint output for invalid @typedef
- Vorherrschende Sprache
- JavaScript
- Sterne
- 5.8k
- Forks
- 481
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
```
/**
* @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.
Beitragsleitfaden
Rechercherichtung
Reproduziere den Bericht mit dem gezeigten ungültigen @typedef-Snippet mithilfe des Dokumentations-Lint-Befehls. Verfolge, wie die Lint-Regel @typedef-Tags parst und Warnpositionen zuweist; vergleiche das Ergebnis mit dem im Issue beschriebenen JSDoc-Verhalten. Als erledigt gilt die Aufgabe, wenn das Verhalten optionaler Typen geklärt ist und jede Warnung die korrekte Zeile und das Tag eindeutig angibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100