glideapps/quicktype

Translate invalid name characters into equivalent names

Open

#631 opened on Mar 6, 2018

View on GitHub
 (3 comments) (1 reaction) (0 assignees)TypeScript (968 forks)batch import
good first issuenaming

Repository metrics

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

Description

Demonstrated by NotExecutable on Reddit:

{"#": "foo", "##": "bar" }

produces this type with strange propery names in C#:

public partial class Root
{
    public string Empty { get; set; }
    public string Purple { get; set; }
}

This would be nicer:

public partial class Root
{
    public string Hash { get; set; }
    public string HashHash { get; set; }
}

Contributor guide

Research direction
Find the function in quicktype that sanitizes property names (likely in a language specific renderer for C#). Look for how invalid characters are handled and add a mapping for '#' to 'Hash'.
Tech stack
typescript
Domain
backendtooling
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptCode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60