bcherny/json-schema-to-typescript

Add option to prepend "readonly" to all fields

Open

#627 aperta il 2 set 2024

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)TypeScript (449 fork)github user discovery
enhancementgood first issuehelp wanted

Metriche repository

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

Descrizione

This would be nice to ensure i don't accidentally try playing with values from responses but create my own local copy instead

Example:

start "" json2ts -i "schemas/pietsmiet.de/*.schema.json" -o "src/responses/pietsmiet.de/" --inferStringEnumKeysFromValues true --readonly true

export interface PietsmietDEConfig {
    readonly API: Record<string, Record<string, string>>;
    readonly URLs: Record<string, string>;
    readonly Limits: Record<string, number>;
    readonly Orders: Record<string, string>;
    readonly Platform: Record<string, string>;
    readonly Stream: Record<string, string>;
  }
...

Guida contributor

Direzione di ricerca
Implementa un flag ` readonly` nella CLI che aggiunge il modificatore `readonly` a tutte le proprietà generate. Modifica la logica di generazione del codice per anteporre `readonly` quando il flag è impostato. Aggiorna test e documentazione di conseguenza.
Tech stack
typescript
Dominio
backendtooling
Tipo issue
Funzionalità
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
TypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70