glideapps/quicktype

Accept JSON5 as input

Open

#1144 opened on Dec 31, 2018

View on GitHub
 (2 comments) (3 reactions) (0 assignees)TypeScript (10,867 stars) (968 forks)batch import
good first issueinput:JSON

Description

JSON is a pretty rigid format, even changes from double quotes to single quotes would fail its validation. It happened many times to me that what I really need to input is not a strict JSON but a Javascript Object. In this regards I think it would be quite convenient if we can add JSON5 as an input source, which is 100% compatible with standard JSON, but with steroids to make most normal Javascript Objects valid as well. For reference, here is the specification of JSON5 https://json5.org/

Contributor guide

Tech stack
typescript
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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.
clear
Prerequisites
TypeScript knowledgeQuicktype codebase familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate how quicktype currently accepts JSON input (likely via a schema parser) and determine where to add a JSON5 option. Consider using an existing JSON5 library (e.g., json5 npm package). Look at the CLI entry point and the input handling code to add support for a new input format. The issue provides a link to json5.org for reference.