glideapps/quicktype

Unhelpful error message when schema JSON is invalid

Open

#1,062 opened on Sep 11, 2018

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

Repository metrics

Stars
 (10,867 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Trace the error origin in the quicktype codebase where 'Defined value expected, but got undefined' is thrown, and improve the error message to indicate the invalid schema structure (e.g., missing definition or malformed JSON).
Tech stack
typescript
Domain
developer experience
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.
Under 1 hour
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
JSON Schema basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80