bcherny/json-schema-to-typescript

error for empty enums

Open

#463 opened on Jun 25, 2022

View on GitHub
 (1 comment) (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

Empty enums such as this

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QueryMsg",
  "type": "string",
  "enum": []
}

produces

export type QueryMsg = ()

which fails as the syntax is not correct

 FAIL  __tests__/index.test.js
  ✕ compiles (186 ms)

  ● compiles

    SyntaxError: '=>' expected. (9:1)
      7 |
      8 | export type QueryMsg = ()
    > 9 |

I've pushed an example that reproduces the exact error https://github.com/pyramation/json-schema-to-typescript-sandbox/blob/main/__tests__/index.test.js#L4-L10

Contributor guide

Research direction
Add a check for empty enum arrays to output an empty type or a never type.
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.
1
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
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80