bcherny/json-schema-to-typescript

Empty objects produce broken schema (empty interface)

Open

#486 aperta il 18 set 2022

Vedi su GitHub
 (3 commenti) (1 reazione) (0 assegnatari)TypeScript (449 fork)github user discovery
buggood first issuehelp wanted

Metriche repository

Star
 (3302 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

I searched a bit but didn't find any issues/discussion that looked relevant, please forgive me if I missed something.

I'm dealing with an api that has "sometype": {} fields sometimes (that is, it requires an empty object) with a definition like

{
  "title": "Empty",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

This produces the invalid ts definition

export interface Empty {}

where I'd expect

export type Empty = Record<string, never>;

Obviously there won't be significant type safety (or unsafety) in these situations, but it will compile/check.

Guida contributor

Direzione di ricerca
Esamina la logica di compilazione dello schema per le definizioni di oggetti vuoti e modifica la generazione dei tipi per produrre Record<string, never> invece di un'interfaccia vuota.
Tech stack
typescript
Dominio
devtools
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptJSON Schema
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75