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 (10,867 stars) (968 forks)batch import
good first issuenaming

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

Tech stack
typescriptcsharp
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.
1-3 hours
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
Basic knowledge of quicktype's code generationUnderstanding of C# naming conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate how quicktype converts invalid JSON property names to valid C# identifiers. Look for a mapping or transformation function that converts characters like '#' to names like 'Hash'. The relevant code is likely in the C# target renderer or a shared name sanitizer. Check the existing mapping and consider adding a translation for '#' to 'Hash', '##' to 'HashHash', etc.