Incorrectly casts `export type X` declarations to class
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- javascript, typescript
- Ambito
- documentation, tooling
Direzione di ricerca
Reproduce the failure with the types.ts export type declaration and the index.js JSDoc typedef shown in the issue. Trace the plugin's handling of TypeScript type declarations and typedef imports; done means JsonPrimitive is no longer cast to Class and the documented example parses without the Invalid docstring error.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
If I use any combination of
// types.ts
/**
* Valid JSON primitive types.
*
* @arbitrary_tag IncludesNotAddingTag
*/
export type JsonPrimitive = (
| string
| number
| boolean
| null
| JsonPrimitive[]
| { [key: string]: JsonPrimitive }
);
with
// index.js
// includes any combination of @typedef {typeof import...}, lack of typeof, etc.
/** @typedef {import('./types').JsonPrimitive} JsonPrimitive */
The plugin fails with:
Error: Invalid docstring * @typedef {Class<import('./types').JsonPrimitive>} JsonPrimitive in /path/to/index.js
TL;DR
Don't automatically cast type declarations to class (who else does that?).
Edit: I realize this plugin was made primarily for classes, but for > 1k downloads, I'd expect it to be a bit more supportive of other types as well.
- Lingua principale
- JavaScript
- Stelle
- 24
- Fork
- 13
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openlayers/jsdoc-plugin-typescript
-
unexpected token errorAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 25/100
Tutte le issue di openlayers/jsdoc-plugin-typescript
Issue simili
-
新讀者走讀回報，照著一篇文章實際操作Apertadocumentation good first issue help wanted
Difficoltà 1/5 1-3 ore Idoneità per principianti 92/100
I maintainer di solito rispondono entro 1 giorno
-
automated issue report
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
lirantal/discoprint#29 ·
I maintainer di solito rispondono entro 1 giorno
-
RSS feed autodiscoveryApertafeature-request
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
louislam/uptime-kuma#7914 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Code Cleanup dependencies
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 68/100
ProjectSidewalk/SidewalkWebpage#5609 ·
I maintainer di solito rispondono entro 1 giorno
-
help wanted javascript
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
OWASP/cornucopia#3538 ·
I maintainer di solito rispondono entro 1 giorno