bcherny/json-schema-to-typescript

Why does description expand referenced type?

Open

#363 opened on Jan 14, 2021

View on GitHub
 (3 comments) (4 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

Can I prevent reference type from expansion?

Input JSON:

{
    "properties": {
      "correct": {
        "$ref": "#/definitions/color"
      },
      "wrong": {
        "description": "should be referenced",
        "$ref": "#/definitions/color"
      }

    },
    "additionalProperties": false,
    "definitions": {
        "color": {
            "type": "string",
            "enum": ["red", "green", "blue"]
        }
    }
}

Actual output:

export type Color = "red" | "green" | "blue";

export interface Bug {
  correct?: Color;
  /**
   * should be referenced
   */
  wrong?: "red" | "green" | "blue";
}

Expected output:

export type Color = "red" | "green" | "blue";

export interface Bug {
  correct?: Color;
  /**
   * should be referenced
   */
  wrong?: Color;
}

Contributor guide

Research direction
Investigate how the tool handles $ref when a sibling description is present; likely the code inverts the priority of explicit description over $ref resolution, causing expansion. Look at the `resolveRef` or `parseSchema` functions to understand how description interacts with $ref.
Tech stack
typescript
Domain
backendtooling
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.
70