bcherny/json-schema-to-typescript

Enhance tsEnumNames

Open

#21 opened on Sep 9, 2016

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (449 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (3,302 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

There are some points where tsEnumNames could be enhanced:

  • JSON is usually often snake_case. Allow ts_enum_names.
  • JSON Editor uses enum_titles for a similar scenario. Allow both or adopt.
  • Space characters will lead to invalid TS. Sanitize or explain in docs.

Contributor guide

Research direction
Examine the current tsEnumNames implementation in the source code, then add support for snake case keys (ts enum names), adopt enum titles from JSON Editor if applicable, and implement sanitization of spaces in enum names or document the limitation.
Tech stack
typescript
Domain
tooling
Issue type
Feature
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.
70