bcherny/json-schema-to-typescript

Adding anything to empty property makes it `Record<string,any>` instead of `any`

Open

#176 opened on Aug 20, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (449 forks)github user discovery
buggood first issuehelp wanted

Repository metrics

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

Description

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://bepis.com/event.schema.json",
  "title": "Event",
  "properties": {
    "data": {}
  },
  "additionalProperties": false,
  "required": ["data"]
}

produces

export interface Event {
  data: any;
}

but

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://bepis.com/event.schema.json",
  "title": "Event",
  "properties": {
    "data": { "description": "" }
  },
  "additionalProperties": false,
  "required": ["data"]
}

immediately produces

export interface Event {
  data: {
    [k: string]: any;
  };
}

Imo, things that don't affect validation should not change the type output?

Contributor guide

Research direction
Investigate the code that handles empty properties without additional attributes vs. with description. Trace how the type is inferred. The bug might be in the schema parsing or type generation logic.
Tech stack
typescript
Domain
tooling
Issue type
Bug
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