contentlayerdev / contentlayerdev/contentlayer

Support referencing TS type definitions for `type: 'json'` fields

Aperta
#26 3 commenti 5 reazioni 0 assegnatari Vedi su GitHub
feature pkg/source-files
Lingua principale
TypeScript
Stelle
3.5k
Fork
192
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

In some cases where you're using `type: 'json'` you'd like to reference some existing TS type definitions instead of the `any` type that's currently used for `json` fields. This applies to both regular `fields` and `computedFields`.

Example:

![image](https://user-images.githubusercontent.com/1567498/140750539-bb4b8f33-517a-4afd-bfdc-df2a767c2767.png)

Rough API idea:

```ts
{
// ...
typescriptType: { name: 'IReadTimeResults', from: 'reading-time' }
}
```

## Notes

- A potential other direction/idea for this could be to "derive" nested document types based on existing TS types. (Would address #149)

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia individuando come viene rappresentato `type: 'json'` per i normali `fields` e `computedFields`, quindi esamina l’API `typescriptType` proposta e il flusso esistente di generazione dei tipi. Il lavoro è completo quando entrambi i tipi di campo possono fare riferimento a una definizione TypeScript esistente invece di usare `any` per impostazione predefinita, con copertura per l’esempio d’uso.

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
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.