bcherny/json-schema-to-typescript

Add option for failing on unknown JSON Schema type

Open

#471 opened on Jul 28, 2022

View on GitHub
 (3 comments) (2 reactions) (0 assignees)TypeScript (449 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (3,302 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently, the generator defaults to type { [k: string]: unknown; } if JSON Schema type is not a valid type. It would be helpful to have an option to make this fail the generation, i.e. throw an error instead of using this default value.

Contributor guide

Research direction
Find where unknown JSON Schema types are defaulted to `{ [k: string]: unknown; }` and add an option to throw an error instead.
Tech stack
typescript
Domain
backendtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptJSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60