microsoft / microsoft/TypeScript
allow inline intellisense comment on es6 export
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
Search Terms
intellisense export
Suggestion
allow inline intellisense documentation of es6 export, or at least propagate the intellisense comments of the exported package. currently nothing is exported (other than type definitions)
Use Cases
allows for index files for large libraries to have better descriptions of the sub-modules it contains.
current (working) approach is to use the old pre-es6 /** comment */export import x = requires("x")
Examples
/** promise fs based api and related quality-of-life helper functions */
import * as fs from "./fs";
export { fs };
the above intellisense comment doesn't propagate.
Checklist
My suggestion meets these guidelines:
- [ X] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [ X] This wouldn't change the runtime behavior of existing JavaScript code
- [ X] This could be implemented without emitting different JS based on the types of the expressions
- [ X] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- [ X] This feature would agree with the rest of TypeScript's Design Goals.
Guida per i contributori
Apri 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.
Direzione di ricerca
Inizia individuando la gestione, da parte del compilatore TypeScript, dei commenti JSDoc o IntelliSense sulle dichiarazioni di esportazione ES6, quindi confrontala con l’esempio fornito export { fs }. Il lavoro è completato quando la descrizione inline viene propagata al pacchetto o modulo esportato senza modificare il JavaScript generato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100