bcherny/json-schema-to-typescript

SyntaxError: Cannot set a numeric title

Open

#185 opened on Sep 17, 2018

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

{
		"type": "object",
		"required": [ "status" ],
		"properties": {
				"status": {
						"type": "string",
						"title": "200",
						"example": "200",
						"description": "...."
					}
		}
}

(node:46816) UnhandledPromiseRejectionWarning: SyntaxError: Declaration or statement expected. (4:1)
  2 |  * ...
  3 |  */
> 4 | export type 200 = string
    | ^
  5 | 
  6 | export interface Request {
  7 | status?: 200
    at e (/Users/monolithed/workspace/vtb/fe-api-doc/node_modules/prettier/parser-typescript.js:1:329)
``

Contributor guide

Research direction
Investigate how json schema to typescript generates type names from JSON Schema titles. The title '200' becomes a numeric type name '200', which is invalid TypeScript. Find where titles are used to generate type names and ensure numeric values are converted to valid identifiers (e.g., prefix with underscore or use alternative naming).
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.
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.
60