microsoft / microsoft/TypeScript
Preserve JSDocs in *.d.ts files when stripping comments
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
Suggestion/Feature
When using the switch removeComments it will strip out all comments including the ones you may consider useful to the end consumer such as JSDocs. I'd like to strip out any internal comments but preserve any JSDocs comments. It seems that an option to preserve comments in types would be sufficient.
Existing functionality
"removeComments": true,
"declaration": true,
removes all comments including those in *.d.ts files.
Suggested functionality
"removeComments": true,
"declaration": true,
I would think by default you'd want to include the JSDocs in your type defs, so this would remove all comments from the code, but retain any comments associated with the types ie JSDocs.
If however, there is a need to remove all comments then an additional switch may be required to serve that purpose:
"removeCommentsIncludingDeclarations": true,
"declaration": true,
Would produce the same result we have today.
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 riproducendo il problema con le opzioni "removeComments" e "declaration" abilitate, quindi confronta l'output JavaScript e .d.ts generato. Il lavoro è completato quando i commenti interni vengono rimossi mentre i commenti JSDoc associati alle dichiarazioni vengono mantenuti, e quando esiste un modo documentato per preservare, se necessario, il comportamento attuale di rimozione di tutti i commenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100