microsoft / microsoft/TypeScript
Support declaring @types as the supported route for typings dependencies in the package.json
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
package json types field types types module
Suggestion
Allow libraries written in JavaScript to be able to declare that they have types in DT (or other modules), and that they support a certain version of it.
For example:
Express does not support TypeScript but trusts that the DefinitelyTyped express maintainers know what they are doing generally. They want to declare that DT is the way for TypeScript users to get types out of the box. Today that's not really possible.
Examples
Two potential routes:
-
Override the "types" parameter to support:
"types": "@types/express:^3.0"in a package.json -
Recommend a new field in the package.json:
"typesModule": "@types/express:^3.0"- then when TypeScript normally offers a 'no types found', then it can offer the command to install with the correct semver range.
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
/cc @wesleytodd @isaacs @ljharb
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 esaminando come TypeScript legge i metadati di package.json e il percorso esistente “no types found”; l’issue non indica alcun file sorgente o test. Il design deve innanzitutto scegliere e specificare come un package dichiara un modulo di typings esterno e il relativo intervallo di semver supportato, quindi verificare che TypeScript possa usare tale dichiarazione per guidare l’installazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 32/100