glideapps/quicktype

Unhelpful error message when schema JSON is invalid

Open

#1062 opened on Sep 11, 2018

View on GitHub
 (4 comments) (20 reactions) (0 assignees)TypeScript (10,867 stars) (968 forks)batch import
CLIbuggood first issue

Description

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$ref": "#/definitions/foo",
  "definitions": {
    "foo": {
      "type": "object",
      "properties": {
        "bar": {
          "$ref": "bar.json#"
        },
      },
      "required": [
        "bar"
      ],
    },
    "title": "foo"
  }
}

Running quicktype CLI with this Schema produces

Error: Internal error: Defined value expected, but got undefined.

Contributor guide

Tech stack
typescriptnodejs
Domain
clideveloper experiencetooling
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the quicktype codebase to locate where the error 'Defined value expected, but got undefined' is thrown, likely in the JSON Schema parser when resolving $ref references. Improve the error message to indicate which part of the schema is invalid, such as the specific $ref or missing definition. Check existing comments or linked issues for additional context.